最近更新时间:2024-08-12 10:30:01
描述当前region下各种资源的标签的功能。
描述标签时,可以指定过滤参数,包括资源类型(resource-type)、资源id(resource-id)、标签分类(key)、标签名称/值(value)四种过滤参数,描述成功返回匹配过滤参数的描述结果及总数,否则返回空。
约束:不同的过滤器的Values是多对多的或关系。
返回API概览
名称 | 类型 | 必须 | 长度限制(字符) | 参数格式 | 描述 |
---|---|---|---|---|---|
Action | String | 是 | 确定值 |
| 操作接口名,系统规定参数,取值:DescribeTags |
Filter.N | Filter 数组 | 否 | 目前支持四种filter:key(标签名称)、value(标签值)、resource-type(资源类型)、resource-id(资源id) | 可选参数,过滤参数列表,缺省描述当前region下所有的标签 | |
MaxResults | Integer | 否 | 最小值5,最大值1000,默认100 | 用于限制本次查询结果返回的结果数量,如果仍有额外结果未显示,同时返回下次查询的起始点NextToken值 | |
NextToken | String | 否 |
| 当返回结果被截断时,使用NextToken值用于标示下次调用查询用户操作的起始点 |
名称 | 类型 | 描述 |
---|---|---|
NextToken | String | 当返回结果被截断时,使用NextToken值用于标示下次调用查询用户操作的起始点,可以缺省 |
TagSum | Integer | 返回匹配当前过滤参数的描述结果的总数(与是否分页无关) |
TagSet | “标签描述”列表 |
错误代码(Code) | 错误消息(Message) | HTTP 状态码 | 中文描述(语义) |
---|---|---|---|
MissingParameter | A required parameter for the specified action is not supplied. | 400 | 忘记必选参数%s,具体参数名在%s说明 |
InvalidParameterValue | An invalid or out-of-range value %s for parameter MaxResults was supplied. | 400 | 参数MaxResults的输入值%s无效、不合法或者超出范围,具体输入值在%s说明 |
InvalidParameterValue | Unable to parse pagination token for parameter NextToken. | 400 | 无法解析参数NextToken的输入值%s,具体输入值在%s说明 |
InvalidParameterValue | The Filter value %s is invalid. | 400 | 过滤器参数输入值%s无效,具体输入值在%s说明 |
InvalidParameter | An invalid parameter in Filters[number]: “%s”, must be one of: Name, Value.number | 400 | 过滤器[数字]的参数%s不合法,应为Name或者Value.number |
描述资源类型为kec-instance,标签名称为Department标签值为Testing,或者标签名称Usage标签值为空的全部结果(假设不存在标签名称为Department标签值为空或者标签名称Usage标签值为Testing的结果)
https://tag.api.ksyun.com/?Action=DescribeTags
&Filter.1.Name=resource-type
&Filter.1.Value=kec-instance
&Filter.2.Name=key
&Filter.2.Value=Department
&Filter.2.Value=Usage
&Filter.3.Name=value
&Filter.3.Value=Testing
&Filter.3.Value=
&公共请求参数
XML格式
<DescribeTagsResponse xmlns="https://tag.ksyun.com/doc/2016-03-04/">
<RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
<TagSum>2</TagSum>
<TagSet>
<member>
<ResourceType>kec-instance</ResourceType>
<ResourceId>d7d3e0b3-eeb1-40a3-89f3-a6100f14522b</ResourceId>
<Key>Department<Key>
<Value>Testing</Value>
</member>
<member>
<ResourceType>kec-instance</ResourceType>
<ResourceId>e1d996e9-d182-4510-a9c7-82b74b6d1b81</ResourceId>
<Key>Usage<Key>
<Value></Value>
</member>
</TagSet>
</DescribeTagsResponse>
JSON示例
{
"RequestId":"7a62c49f-347e-4fc4-9331-6e8eEXAMPLE",
"TagSum":2,
"TagSet":[
{
"ResourceType": "kec-instance",
"ResourceId": "d7d3e0b3-eeb1-40a3-89f3-a6100f14522b",
"Key": "Department",
"Value": "Testing"
},
{
"ResourceType": "kec-instance",
"ResourceId": "e1d996e9-d182-4510-a9c7-82b74b6d1b81",
"Key": "Usage",
"Value": ""
}
]
}
纯净模式