All Products
Document Center

Query IP access control bound to APIs (DescribeApiIpControls)

Last Updated: Feb 25, 2018


Query IP access control bound to all APIs in a specified group under specified environment.

  • This function is intended for open API users.
  • It is used to query the summary of IP access control bindings of all APIs of a specified group in a specified environment.
  • If optional parameters are left blank, all bindings are returned. The results are displayed on multiple pages.

Request parameters

Parameter Type Required Description
Action String Yes Operation interface name, a required parameter, value: DescribeApiIpControls
StageName String Yes Environment of APIs
  • RELEASE: online environment
  • TEST: test environment
GroupId String Yes ID of the API group you want to query
ApiIds String No IDs of the APIs you want to query. If multiple API IDs are input, they must be separated by a comma (,). Up to 100 API IDs can be input.
PageNumber Integer No Page number specified for query; default value: 1; start number: 1
PageSize Integer No Number of lines per page; maximum value: 100; default value: 10

Response parameters

Parameter Type Description
RequestId String ID of the current request
TotalCount Integer Total number of returned results
PageSize Integer Number of results returned per page
PageNumber Integer Page number for returned results
ApiIpControls ApiIpControlItem ApiIpControlItem array, containing IP access control information items


Sample request

  2. &StageName=test
  3. &GroupId=0009db9c828549768a200320714b8930
  4. &<Public Request Parameters>

Sample response

XML format

  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 format

  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. }