文档

DescribeApisByTrafficControl - 查询指定流控策略下已绑定API列表信息

更新时间:

查询指定流控策略下已绑定的API列表信息。

接口说明

  • 此功能面向开放 API 的用户
  • 分页返回

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
TrafficControlIdstring

指定查询要用的流控策略 ID

dd05f1c54d6749eda95f9fa6d491449a
PageSizeinteger

指定分页查询时每页行数,最大值 100,默认值为 10

10
PageNumberinteger

指定要查询的页码,默认是 1,起始是 1

1

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

20
ApiInfosobject []

由 ApiInfo 组成的数组格式,返回 API 的信息项

BoundTimestring

绑定时间

2016-07-23T08:28:48Z
Visibilitystring

可见性,枚举为:

  • PUBLIC: 公开
  • PRIVATE: 私有
PUBLIC
ApiIdstring

API 编号

3b81fd160f5645e097cc8855d75a1cf6
Descriptionstring

API 描述

描述
GroupNamestring

API 分组名称

mygroup
GroupIdstring

API 分组编号

0009db9c828549768a200320714b8930
StageNamestring

环境名称,枚举为:

  • RELEASE: 线上
  • TEST: 测试
TEST
ApiNamestring

API 名称

testapi
RegionIdstring

所在的 region

cn-qingdao

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiInfos": {
    "ApiInfo": [
      {
        "BoundTime": "2016-07-23T08:28:48Z",
        "Visibility": "PUBLIC",
        "ApiId": "3b81fd160f5645e097cc8855d75a1cf6",
        "Description": "描述",
        "GroupName": "mygroup",
        "GroupId": "0009db9c828549768a200320714b8930",
        "StageName": "TEST",
        "ApiName": "testapi",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiInfos": {
    "ApiInfo": [
      {
        "BoundTime": "2016-07-23T08:28:48Z",
        "Visibility": "PUBLIC",
        "ApiId": "3b81fd160f5645e097cc8855d75a1cf6",
        "Description": "描述",
        "GroupName": "mygroup",
        "GroupId": "0009db9c828549768a200320714b8930",
        "StageName": "TEST",
        "ApiName": "testapi",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

错误码

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

  • 本页导读 (1)