调用DescribeApiIpControls查询指定分组指定环境下,所有API的IP访问控制绑定情况。
- 此功能面向开放API的用户
-
非必填的参数,不传入则默认返回所有,分页返回
·
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
GroupId | String | 是 | 0009db9c828549768a200320714b8930 |
指定要查询的分组 |
StageName | String | 是 | test |
指定要查询的环境。
|
Action | String | 否 | DescribeApiIpControls |
操作接口名,系统规定参数,取值:DescribeApiIpControls。 |
ApiIds | String | 否 | 123,234 |
指定要查询的API编号,支持输入多个,半角逗号(,)分隔,最多支持100个 |
PageNumber | Integer | 否 | 1 |
指定要查询的页码,默认是1,起始是1 |
PageSize | Integer | 否 | 10 |
指定分页查询时每页行数,最大值100,默认值为10 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ApiIpControls | Array |
由 ApiIpControlItem组成的数组格式,返回IP访问控制的信息项 |
|
ApiIpControlItem |
由 ApiIpControlItem组成的数组格式,返回IP访问控制的信息项 |
||
ApiId | String | 46fbb52840d146f186e38e8e70fc8c90 |
API编号 |
ApiName | String | testapi |
API名称 |
BoundTime | String | 2016-07-23T08:28:48Z |
绑定时间 |
IpControlId | String | dd05f1c54d6749eda95f9fa6d491449a |
IP访问控制ID |
IpControlName | String | testControlName |
IP访问控制名称 |
PageNumber | Integer | 1 |
返回指定的页码 |
PageSize | Integer | 10 |
返回指定的每页条数 |
RequestId | String | CEF72CEB-54B6-4AE8-B225-F876FF7BZ004 |
请求ID |
TotalCount | Integer | 1 |
返回结果的总条数 |
示例
请求示例
https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiIpControls
&StageName=test
&GroupId=0009db9c828549768a200320714b8930
&<公共请求参数>
正常返回示例
XML
格式
<DescribeApiIpControlsResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
<TotalCount>20</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<ApiSignatures>
<ApiSignatureItem>
<ApiId>46fbb52840d146f186e38e8e70fc8c90</ApiId>
<ApiName>testapi</ApiName>
<IpControlId>dd05f1c54d6749eda95f9fa6d491449a</IpControlId>
<IpControlName>testControlName</IpControlName>
<BoundTime>2016-07-23T08:28:48Z</BoundTime>
</ApiSignatureItem>
</ApiSignatures>
</DescribeApiIpControlsResponse>
JSON
格式
{
"PageNumber":"1",
"TotalCount":"20",
"PageSize":"10",
"RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
"ApiSignatures":{
"ApiSignatureItem":[
{
"BoundTime":"2016-07-23T08:28:48Z",
"IpControlName":"testControlName",
"ApiName":"testapi",
"IpControlId":"dd05f1c54d6749eda95f9fa6d491449a",
"ApiId":"46fbb52840d146f186e38e8e70fc8c90"
}
]
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交