调用DescribeApiIpControls查询API的IP访问控制绑定情况_API 网关(API Gateway)-阿里云帮助中心

查询指定分组指定环境下，所有API的IP访问控制绑定情况。

接口说明

此功能面向开放 API 的用户
非必填的参数，不传入则默认返回所有，分页返回 ·

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
StageName	string	是	指定要查询的环境。 RELEASE: 线上 TEST: 测试	test
GroupId	string	是	指定要查询的分组	0009db9c828549768a200320714b8930
ApiIds	string	否	指定要查询的 API 编号，支持输入多个，半角逗号（,）分隔，最多支持 100 个	123,234
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	1
PageSize	integer	否	指定分页查询时每页行数，最大值 100，默认值为 10	10

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSize	integer	返回指定的每页条数	10
TotalCount	integer	返回结果的总条数	1
ApiIpControls	array<object>	由 ApiIpControlItem 组成的数组格式，返回 IP 访问控制的信息项
ApiIpControlItem	object
BoundTime	string	绑定时间	2016-07-23T08:28:48Z
ApiId	string	API 编号	46fbb52840d146f186e38e8e70fc8c90
IpControlId	string	IP 访问控制 ID	dd05f1c54d6749eda95f9fa6d491449a
IpControlName	string	IP 访问控制名称	testControlName
ApiName	string	API 名称	testapi

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史