Query IP access control bound to APIs (DescribeApiIpControls) - Developer Guide| Alibaba Cloud Documentation Center

Description

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

Example

Sample request

https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiIpControls
&StageName=test
&GroupId=0009db9c828549768a200320714b8930
&<Public Request Parameters>

Sample response

XML format

<DescribeApiSignaturesResponse>
    <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>
</DescribeApiSignaturesResponse>

JSON format

{
    "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
    "TotalCount": "20",
    "PageSize": "10",
    "PageNumber": "1",
    "ApiSignatures": {
      "ApiSignatureItem": [
        {
          "ApiId": "46fbb52840d146f186e38e8e70fc8c90",
          "ApiName": "testapi",
          "IpControlId": "dd05f1c54d6749eda95f9fa6d491449a",
          "IpControlName": "testControlName",
          "BoundTime": "2016-07-23T08:28:48Z"
        }
      ]
    }   
}