全部产品
云市场

查询 API 上IP访问控制的绑定情况 (DescribeApiIpControls)

更新时间:2018-02-25 11:52:17

描述

查询指定分组指定环境下所有API的IP访问控制绑定情况

  • 此功能面向开放API的用户
  • 用于查询指定分组指定环境下,所有API的IP访问控制绑定概况
  • 非必填的参数,不传入则默认返回所有,分页返回

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:DescribeApiIpControls
StageName String 指定要查询的环境。
  • RELEASE: 线上
  • TEST: 测试
GroupId String 指定要查询的分组
ApiIds String 指定要查询的API编号,支持输入多个,半角逗号(,)分隔,最多支持100个
PageNumber Integer 指定要查询的页码,默认是1,起始是1
PageSize Integer 指定分页查询时每页行数,最大值100,默认值为10

返回参数

名称 类型 描述
RequestId String 本次请求编号
TotalCount Integer 返回结果的总条数
PageSize Integer 返回指定的每页条数
PageNumber Integer 返回指定的页码
ApiIpControls ApiIpControlItem ApiIpControlItem组成的数组格式,返回IP访问控制的信息项

示例

请求示例

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

返回示例

XML格式

  1. <DescribeApiSignaturesResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. <TotalCount>20</TotalCount>
  4. <PageSize>10</PageSize>
  5. <PageNumber>1</PageNumber>
  6. <ApiSignatures>
  7. <ApiSignatureItem>
  8. <ApiId>46fbb52840d146f186e38e8e70fc8c90</ApiId>
  9. <ApiName>testapi</ApiName>
  10. <IpControlId>dd05f1c54d6749eda95f9fa6d491449a</IpControlId>
  11. <IpControlName>testControlName</IpControlName>
  12. <BoundTime>2016-07-23T08:28:48Z</BoundTime>
  13. </ApiSignatureItem>
  14. </ApiSignatures>
  15. </DescribeApiSignaturesResponse>

JSON格式

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3. "TotalCount": "20",
  4. "PageSize": "10",
  5. "PageNumber": "1",
  6. "ApiSignatures": {
  7. "ApiSignatureItem": [
  8. {
  9. "ApiId": "46fbb52840d146f186e38e8e70fc8c90",
  10. "ApiName": "testapi",
  11. "IpControlId": "dd05f1c54d6749eda95f9fa6d491449a",
  12. "IpControlName": "testControlName",
  13. "BoundTime": "2016-07-23T08:28:48Z"
  14. }
  15. ]
  16. }
  17. }