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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
TrafficControlId String 是 dd05f1c54d6749eda95f9fa6d491449a

指定查询要用的流控策略ID
Action String 否 DescribeApisByTrafficControl

操作接口名，系统规定参数，取值：DescribeApisByTrafficControl。

PageNumber Integer 否 1

指定要查询的页码，默认是1，起始是1
PageSize Integer 否 10

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

返回数据

名称 类型 示例值 描述
ApiInfos Array

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

由 ApiInfo 组成的数组格式，返回API的信息项
ApiId String 3b81fd160f5645e097cc8855d75a1cf6

API编号
ApiName String testapi

API名称
BoundTime String 2016-07-23T08:28:48Z

绑定时间
Description String 描述

API描述
GroupId String 0009db9c828549768a200320714b8930

API分组编号
GroupName String mygroup

API分组名称
RegionId String cn-qingdao

所在的region
StageName String TEST

环境名称，枚举为：

  • RELEASE: 线上
  • TEST: 测试
Visibility String PUBLIC

可见性，枚举为：

  • PUBLIC: 公开
  • PRIVATE: 私有
PageNumber Integer 1

返回指定的页码
PageSize Integer 10

返回指定的每页条数
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

请求ID
TotalCount Integer 20

返回结果的总条数

示例

请求示例


https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApisByTrafficControl
&TrafficControlId=dd05f1c54d6749eda95f9fa6d491449a
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeApisByTrafficControlResponse>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
      <TotalCount>20</TotalCount>
      <PageSize>10</PageSize>
      <PageNumber>1</PageNumber>
      <ApiInfos>
            <ApiInfo>
                  <RegionId>cn-qingdao</RegionId>
                  <GroupId>0009db9c828549768a200320714b8930</GroupId>        
                  <GroupName>mygroup</GroupName>
                  <StageName>test</StageName>
                  <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>
                  <ApiName>testapi</ApiName>
                  <Description>描述</Description>
                  <Visibility>public</Visibility>
                  <BoundTime>2016-07-23T08:28:48Z</BoundTime>
            </ApiInfo>
      </ApiInfos>
</DescribeApisByTrafficControlResponse>

JSON 格式 

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

错误码

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