接口说明
为实例、密钥对等资源绑定标签(支持批量)。
注意事项:
-
若标签未创建则会创建并绑定标签。
-
一个资源最多绑定十个标签。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/tags/bind
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
bindTagsReq
|
BindTagsReq
|
是
|
bindTagsReq |
|
resourceType
|
string
|
是
|
资源类型定义。取值范围:
|
|
resourceIds
|
<string> array
|
是
|
同一类型下的资源ID数组。 |
|
tags
|
<Tag> array
|
是
|
标签。 |
|
key
|
string
|
是
|
标签键,仅支持中英文、数字、中划线、下划线,长度1-127位之间,不能以 |
|
value
|
string
|
是
|
标签值,仅支持数字、中英文、中划线、下划线,长度在1~255位之间,不能以 |
|
syncSystemDisk
|
boolean
|
否
|
是否同步修改实例的系统盘标签,仅资源类型为VM、DDHVM时有效,默认值:false。 |
|
syncVolume
|
boolean
|
否
|
是否同步修改实例挂载的云硬盘标签,仅资源类型为VM、DDHVM时有效,默认值:false。 |
|
syncEip
|
boolean
|
否
|
是否同步修改实例绑定的弹性公网IP标签,仅资源类型为VM、DDHVM时有效,默认值:false。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/tags/bind
{
"resourceIds":[
"c31decac-***-67df3d2bad80"
],
"resourceType":"VM",
"tags":[
{
"key":"111",
"value":"aaa"
}
]
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
BatchAction«TagActionResult»
|
请求成功时返回的数据。 |
|
instanceBatchResult
|
<TagActionResult> array
|
实例批量操作结果集。 |
|
resourceType
|
string
|
资源类型。 |
|
resourceId
|
string
|
资源ID。 |
|
result
|
boolean
|
操作是否成功。 |
|
message
|
string
|
操作结果信息,失败时返回错误信息,成功时返回空。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。 |
返回示例
返回码:200
OK
{
"requestId":"reqId-e52f5965-***-779ea83261e9",
"state":"OK",
"body":{
"instanceBatchResult":[
{
"resourceType":"VM",
"resourceId":"c31decac-***-67df3d2bad80",
"result":true,
"message":null
}
]
}
}