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

查询指定IP访问控制所绑定的API列表信息。

接口说明

此功能面向开放 API 的用户
分页返回

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeApisByIpControl	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
IpControlId	string	是	指定查询要用的 IP 访问控制 ID	dd05f1c54d6749eda95f9fa6d491449a
PageSize	integer	否	指定分页查询时每页行数，最大值 100，默认值为 10	10
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	1

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID	CEF72CEB-54B6-4AE8-B225-F876FF7BZ004
PageSize	integer	返回指定的每页条数	10
TotalCount	integer	返回结果的总条数	20
ApiInfos	array<object>	由 ApiInfo 组成的数组格式，返回 API 的信息项
ApiInfo	object
BoundTime	string	绑定时间	2016-07-23T08:28:48Z
Visibility	string	可见性，枚举为： PUBLIC: 公开 PRIVATE: 私有	PUBLIC
ApiId	string	API 编号	3b81fd160f5645e097cc8855d75a1cf6
Description	string	API 描述	描述
GroupName	string	API 分组名称	mygroup
GroupId	string	API 分组编号	0009db9c828549768a200320714b8930
StageName	string	环境名称，枚举为： RELEASE: 线上 TEST: 测试	TEST
ApiName	string	API 名称	testapi
RegionId	string	所在的 region	cn-qingdao

示例

正常返回示例

JSON格式

{
  "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": "描述",
        "GroupName": "mygroup",
        "GroupId": "0009db9c828549768a200320714b8930",
        "StageName": "TEST",
        "ApiName": "testapi",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

JSON格式

{
  "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": "描述",
        "GroupName": "mygroup",
        "GroupId": "0009db9c828549768a200320714b8930",
        "StageName": "TEST",
        "ApiName": "testapi",
        "RegionId": "cn-qingdao"
      }
    ]
  }
}

错误码

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