DescribeApisByIpControl - 查询IP访问控制绑定的API - API 网关

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

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
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	由 ApiInfo 组成的数组格式，返回API的信息项
	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

示例

请求示例

https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApisByIpControl
&IpControlId=dd05f1c54d6749eda95f9fa6d491449a
&<公共请求参数>

正常返回示例

JSON格式

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

XML格式

<DescribeApisByIpControlResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
    <TotalCount>20</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <ApiInfos>
        <ApiInfo>
            <RegionId>cn-qingdao</RegionId>
            <GroupId>0009db9c828549768a200320714b8930</GroupId>        
            <GroupName>mygroup</GroupName>
            <StageName>test</StageName>
            <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>
            <ApiName>testapi</ApiName>
            <Description>描述</Description>
            <Visibility>public</Visibility>
            <BoundTime>2016-07-23T08:28:48Z</BoundTime>
        </ApiInfo>
    </ApiInfos>
</DescribeApisByIpControlResponse>

错误码

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