All Products
Search
Document Center

API Gateway:DescribeApiIpControls

Last Updated:Mar 01, 2024

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

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
StageNamestringYes

The runtime environment. Valid values:

  • RELEASE
  • TEST
test
GroupIdstringYes

The ID of the API group.

0009db9c828549768a200320714b8930
ApiIdsstringNo

The IDs of APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered.

123,234
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

1
ApiIpControlsobject []

The information about the ACLs. The information is an array of ApiIpControlItem data.

BoundTimestring

The time of binding.

2016-07-23T08:28:48Z
ApiIdstring

The ID of the API.

46fbb52840d146f186e38e8e70fc8c90
IpControlIdstring

The ID of the ACL.

dd05f1c54d6749eda95f9fa6d491449a
IpControlNamestring

The name of the ACL.

testControlName
ApiNamestring

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 timeSummary of changesOperation
No change history