描述标签名称

最近更新时间:2018-05-31 17:43:54

描述标签名称(DescribeTagValues)

描述

描述当前region下指定标签分类的标签名称的功能。

描述标签名称时,需要指定标签分类,描述成功返回匹配标签分类的描述结果及总数,否则返回空。

返回API概览

请求参数

名称 类型 必须 长度限制(字符) 参数格式 描述
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:DescribeTagValues
TagKey String 最短是1,最长127 [\u0020-\u00FF\u4E00-\u9FFF]+ 必选参数,待描述的标签分类列表
MaxResults Integer 最小值5,最大值1000,默认100 用于限制本次查询结果返回的结果数量,如果仍有额外结果未显示,同时返回下次查询的起始点NextToken值
NextToken String [a-zA-Z]+ 当返回结果被截断时,使用NextToken值用于标示下次调用查询用户操作的起始点

返回元素(调用成功)

名称 类型 描述
NextToken String 当返回结果被截断时,使用NextToken值用于标示下次调用查询用户操作的起始点,可以缺省
TagValueSum Integer 本次查询返回的标签名称总数(与是否分页无关)
TagValueSet Tag 列表 “标签”列表

错误码(调用不成功)

错误代码(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 TagKey value %s is invalid. 400 TagKey参数输入值%s无效,具体输入值在%s说明

示例(调用成功)

描述标签分类为Department的标签名称全部结果

请求示例

https://tag.api.ksyun.com/?Action=DescribeTagValues
&TagKey=Department
&公共请求参数

返回示例

  • XML格式
<DescribeTagValuesResponse xmlns="https://tag.ksyun.com/doc/2016-03-04/">
    <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
    <TagValueSum>2</TagValueSum>
    <TagValueSet>
        <member>
            <Key>Department<Key>
            <Value>Testing</Value>
        </member>
        <member>
            <Key>Department<Key>
            <Value></Value>
        </member>
    </TagValueSet>
</DescribeTagValuesResponse>
  • JSON示例
{
    "RequestId":"7a62c49f-347e-4fc4-9331-6e8eEXAMPLE",
    "TagValueSum":2,
    "TagSet":[
        {
            "Key": "Department",
            "Value": "Testing"
        },
        {
            "Key": "Department",
            "Value": ""
        }
    ]
}

金山云,开启您的云计算之旅

免费注册