DescribeApiIpControls - API Gateway - Alibaba Cloud Documentation Center

Queries the access control lists (ACLs) that are bound to all the APIs in an API group in a specified environment.

Operation description

This operation is intended for API callers.
If an optional parameter is not specified, all results are returned on separate pages.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
StageName	string	Yes	The runtime environment. Valid values: RELEASE TEST	test
GroupId	string	Yes	The ID of the API group.	0009db9c828549768a200320714b8930
ApiIds	string	No	The IDs of APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.	123,234
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10

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.	1
ApiIpControls	array<object>	The information about the ACLs. The information is an array of ApiIpControlItem data.
ApiIpControlItem	object
BoundTime	string	The time of binding.	2016-07-23T08:28:48Z
ApiId	string	The ID of the API.	46fbb52840d146f186e38e8e70fc8c90
IpControlId	string	The ID of the ACL.	dd05f1c54d6749eda95f9fa6d491449a
IpControlName	string	The name of the ACL.	testControlName
ApiName	string	The name of the API.	testapi

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details