使用DescribeApisByVpcAccess查询VPC授权绑定的API信息-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

查询指定地域内指定api的访问控制绑定情况。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DescribeApisByVpcAccess

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
VpcName	string	否	Vpc 授权的名称	lynkco-iov-uat
PageSize	integer	否	指定分页查询时每页行数，最大值 100，默认值为 10	10
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	2

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	指定要查询的页码，默认是 1，起始是 1	1
RequestId	string	请求 id	4E707B25-5119-5ACF-9D26-7D2A2762F05C
PageSize	integer	指定分页查询时每页行数，最大值 100，默认值为 10	10
TotalCount	integer	总条目数	12
ApiVpcAccessInfos	object
ApiVpcAccessInfo	array<object>	由 apiinfo 组成的数组格式，返回 api 的信息项
	object
ApiId	string	API 的 ID	09839002de484e76b5a213b040a6a3ca
VpcId	string	vpc id	vpc-2ze7bj64wstznvftrskbk
InstanceId	string	VPC 授权中的实例 ID 或 IP	Ib-04e41XXXXXd95e9c1
Port	integer	端口号	443
RegionId	string	所在的 region	cn-shanghai
StageId	string	运行环境编号	57e17906a69b4424914fb1e05f67c78a
VpcName	string	VPC 授权的名称	aliYun_service_prod
GroupId	string	分组 ID	41c33748cbfb41f6b00870156203b72a
GroupName	string	API 分组名称	RT_PLU_IP_CTRL_group
Description	string	描述，不超过 200 个字符	123
StageName	string	API 的环境。 RELEASE: 线上 PRE: 预发 TEST: 测试	RELEASE
ApiName	string	API 名称	iwc
Path	string	API 请求路径	/api/v1/friends/rc/status
Method	string	API 的请求 HTTP Method	POST

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "4E707B25-5119-5ACF-9D26-7D2A2762F05C",
  "PageSize": 10,
  "TotalCount": 12,
  "ApiVpcAccessInfos": {
    "ApiVpcAccessInfo": [
      {
        "ApiId": "09839002de484e76b5a213b040a6a3ca",
        "VpcId": "vpc-2ze7bj64wstznvftrskbk",
        "InstanceId": "Ib-04e41XXXXXd95e9c1",
        "Port": 443,
        "RegionId": "cn-shanghai",
        "StageId": "57e17906a69b4424914fb1e05f67c78a",
        "VpcName": "aliYun_service_prod",
        "GroupId": "41c33748cbfb41f6b00870156203b72a",
        "GroupName": "RT_PLU_IP_CTRL_group",
        "Description": "123",
        "StageName": "RELEASE",
        "ApiName": "iwc",
        "Path": "/api/v1/friends/rc/status",
        "Method": "POST"
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。