DescribeApisByIpControl - API Gateway - Alibaba Cloud Documentation Center

Queries the APIs that are bound to an access control list (ACL).

Operation description

This operation is intended for API callers.
You can specify PageNumber to obtain the result on the specified page.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
IpControlId	string	Yes	The ID of the ACL.	dd05f1c54d6749eda95f9fa6d491449a
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	20
ApiInfos	object []	The returned API information. It is an array of ApiInfo data.
BoundTime	string	The time of API binding.	2016-07-23T08:28:48Z
Visibility	string	The visibility of the API. Valid values: PUBLIC PRIVATE	PUBLIC
ApiId	string	The ID of the API.	3b81fd160f5645e097cc8855d75a1cf6
Description	string	The description of the API.	Description
GroupName	string	The name of the API group.	mygroup
GroupId	string	The ID of the API group.	0009db9c828549768a200320714b8930
StageName	string	The name of the runtime environment. Valid values: RELEASE **TEST.	TEST
ApiName	string	The name of the API	testapi
RegionId	string	The region in which the API is located.	cn-qingdao

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  "PageSize": 10,
  "TotalCount": 20,
  "ApiInfos": {
    "ApiInfo": [
      {
        "BoundTime": "2016-07-23T08:28:48Z",
        "Visibility": "PUBLIC",
        "ApiId": "3b81fd160f5645e097cc8855d75a1cf6",
        "Description": "Description\n",
        "GroupName": "mygroup",
        "GroupId": "0009db9c828549768a200320714b8930",
        "StageName": "TEST",
        "ApiName": "testapi",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.