edit-icon download-icon

Query the APIs bound to an IP access control (DescribeApisByIpControl)

Last Updated: Feb 25, 2018

Description

Query the APIs bound to an IP access control.

  • This function is intended for open API users.
  • It is used to query the list of APIs bound to a specified IP access control.
  • Return results are displayed on multiple pages.

Request parameters

Parameter Type Required Description
Action String Yes Operation interface name, a required parameter, value: DescribeApisByIpControl
IpControlId String Yes IP access control ID used for query
PageSize Integer No Number of lines per page; maximum value: 100; default value: 10
PageNumber Integer No Page number specified for query; default value: 1; start number: 1

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
ApiInfos ApiInfo ApiInfo array, containing API information items

Example

Sample request

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApisByIpControl
  2. &IpControlId=dd05f1c54d6749eda95f9fa6d491449a
  3. &<Public Request Parameters>

Sample response

XML format

  1. <DescribeApisBySignatureResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. <TotalCount>20</TotalCount>
  4. <PageSize>10</PageSize>
  5. <PageNumber>1</PageNumber>
  6. <ApiInfos>
  7. <ApiInfo>
  8. <RegionId>cn-qingdao</RegionId>
  9. <GroupId>0009db9c828549768a200320714b8930</GroupId>
  10. <GroupName>mygroup</GroupName>
  11. <StageName>test</StageName>
  12. <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>
  13. <ApiName>testapi</ApiName>
  14. <Description>Description</Description>
  15. <Visibility>public</Visibility>
  16. <BoundTime>2016-07-23T08:28:48Z</BoundTime>
  17. </ApiInfo>
  18. </ApiInfos>
  19. </DescribeApisBySignatureResponse>

JSON format

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3. "TotalCount": "20",
  4. "PageSize": "10",
  5. "PageNumber": "1",
  6. "ApiInfos": {
  7. "ApiInfo": [
  8. {
  9. "RegionId": "cn-qingdao",
  10. "GroupId": "0009db9c828549768a200320714b8930",
  11. "GroupName": "mygroup",
  12. "StageName": "test",
  13. "ApiId": "3b81fd160f5645e097cc8855d75a1cf6",
  14. "ApiName": "testapi",
  15. "Description": "Description",
  16. "Visibility": "public",
  17. "BoundTime": "2016-07-23T08:28:48Z"
  18. }
  19. ]
  20. }
  21. }
Thank you! We've received your feedback.