调用DescribeTagKeys查询所有标签键及标签键关联的DDoS高防(新BGP)实例的数量。

使用说明

本接口用于分页查询所有标签键及标签键关联的DDoS高防(新BGP)实例的数量。

说明 只有DDoS高防(新BGP)服务支持标签功能。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeTagKeys

要执行的操作。取值:DescribeTagKeys

RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值固定为cn-hangzhou,表示中国内地,即DDoS高防(新BGP)服务。

ResourceGroupId String rg-acfm2pz25js****

DDoS高防实例在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

ResourceType String INSTANCE

资源类型。取值固定为INSTANCE,表示DDoS高防实例。

PageSize Integer 10

分页查询时,设置每页包含标签键的数量。默认值为10

PageNumber Integer 1

分页查询时,设置当前页面的页码。默认值为1

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String 6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1

本次请求的ID。

PageNumber Integer 1

当前页面的页码。

PageSize Integer 10

每页包含标签键的数量。

TotalCount Integer 1

查询到的标签键的总数量。

TagKeys Array of TagKey

标签键详情列表。

TagCount Integer 2

标签键关联的DDoS高防(新BGP)实例的数量。

TagKey String aa1

标签键。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTagKeys
&RegionId=cn-hangzhou
&ResourceType=INSTANCE
&PageSize=10
&PageNumber=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTagKeysResponse>
    <RequestId>6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <TagKeys>
        <TagCount>2</TagCount>
        <TagKey>aa1</TagKey>
    </TagKeys>
</DescribeTagKeysResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "TagKeys" : [ {
    "TagCount" : 2,
    "TagKey" : "aa1"
  } ]
}

错误码

访问错误中心查看更多错误码。