调用DescribeTrafficControlsByApi查询指定API已绑定的流控策略。

  • 此功能面向开放API的用户

调试

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

请求参数

名称 类型 是否必选 示例值 描述
ApiId String 3b81fd160f5645e097cc8855d75a1cf6

指定要查询的Api编号

GroupId String 0009db9c828549768a200320714b8930

指定要查询的API所属分组

StageName String RELEASE

指定要查询的环境。

  • RELEASE:线上
  • TEST:测试
Action String DescribeTrafficControlsByApi

操作接口名,系统规定参数,取值:DescribeTrafficControlsByApi

返回数据

名称 类型 示例值 描述
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BZ004

请求ID

TrafficControlItems Array

由 TrafficControlItem 组成的数组格式,返回策略的信息项

TrafficControlItem

由 TrafficControlItem 组成的数组格式,返回策略的信息项

BoundTime String 2016-07-23T08:28:48Z

绑定时间

TrafficControlItemId String dd05f1c54d6749eda95f9fa6d491449a

流控策略ID

TrafficControlItemName String mysecret

流控策略名称

示例

请求示例


https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeTrafficControlByApi
&GroupId=0009db9c828549768a200320714b8930
&ApiId=3b81fd160f5645e097cc8855d75a1cf6
&StageName=test
&<公共请求参数>

正常返回示例

XML 格式

<DescribeTrafficControlByApiResponse>
      <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
      <TrafficControlItems>
            <TrafficControlItem>
                  <TrafficControlId>dd05f1c54d6749eda95f9fa6d491449a</TrafficControlId>        
                  <TrafficControlName>mysecret</TrafficControlName>
                  <BoundTime>2016-07-23T08:28:48Z</BoundTime>
            </TrafficControlItem>
      </TrafficControlItems>
</DescribeTrafficControlByApiResponse>

JSON 格式

{
	"TrafficControlItems":{
		"TrafficControlItem":[
			{
				"BoundTime":"2016-07-23T08:28:48Z",
				"TrafficControlName":"mysecret",
				"TrafficControlId":"dd05f1c54d6749eda95f9fa6d491449a"
			}
		]
	},
	"RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
}

错误码

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