文档

DescribeVpcAccesses - 查询授权的VPC列表

更新时间:

查询已授权的VPC列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
PageNumberinteger

指定要查询的页码,默认是 1,起始是 1

1
PageSizeinteger

指定分页查询时每页行数,最大值 100,默认值为 10

10
Namestring

自定义授权名称,需要保持唯一,不能重复

wuying-edm-svc
VpcAccessIdstring

Vpc 授权 ID

vpc-*****ssds24
AccurateQueryboolean

是否进行精准查询

false
VpcIdstring

专用网络 ID

vpc-uf657qec7lx42paw3qxxx
InstanceIdstring

VPC 授权中的实例 ID 或 IP

10.199.26.***
Portstring

服务端口。

8080
Tagobject []

端口号

Keystring

标签键

appname
Valuestring

标签值

product

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID

8883AC74-259D-4C0B-99FC-0B7F9A588B2F
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

1
VpcAccessAttributesobject []

由 VpcAccessAttribute 组成的数组格式,返回 VPC 授权信息

VpcIdstring

专用网络 ID

vpc-uf657qec7lx42paw3qxxx
Descriptionstring

VPC 授权的描述

测试
InstanceIdstring

专用网络中的实例 ID(ECS/SLB)

i-uf6bzcg1pr4oh5jjmxxx
Portinteger

实例对应的端口号

80
Namestring

授权名称

test
CreatedTimestring

创建时间

2017-01-30T04:10:19Z
RegionIdstring

地域 ID

cn-hangzhou
VpcAccessIdstring

vpc 授权 ID

vpc-*****ssds24
VpcTargetHostNamestring

后端服务的 host

hos-a***.fh-**nc.com
Tagsobject []

标签。

Keystring

标签键。

PROJECT
Valuestring

标签值

6427a17ae6041d1be62414e4

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "8883AC74-259D-4C0B-99FC-0B7F9A588B2F",
  "PageSize": 10,
  "TotalCount": 1,
  "VpcAccessAttributes": {
    "VpcAccessAttribute": [
      {
        "VpcId": "vpc-uf657qec7lx42paw3qxxx",
        "Description": "测试",
        "InstanceId": "i-uf6bzcg1pr4oh5jjmxxx",
        "Port": 80,
        "Name": "test",
        "CreatedTime": "2017-01-30T04:10:19Z",
        "RegionId": "cn-hangzhou",
        "VpcAccessId": "vpc-*****ssds24",
        "VpcTargetHostName": "hos-a***.fh-**nc.com",
        "Tags": {
          "TagInfo": [
            {
              "Key": "PROJECT",
              "Value": "6427a17ae6041d1be62414e4"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-11OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AccurateQuery
2023-12-07OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
出参OpenAPI 返回结构发生变更
2021-12-31OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:VpcId
    新增入参:InstanceId
    新增入参:Port
  • 本页导读 (1)