列出 VPC

更新时间:
复制 MD 格式

使用 ListVpcInfoByAgentStorage 接口分页查询 AgentStorage 的 VPC 绑定及连接地址。

前提条件

  • 拥有阿里云账号并获取 AccessKey(AccessKey ID 和 AccessKey Secret),用于管控面 OpenAPI 签名认证。

  • 当前账号或 RAM 子账号具备 AgentStorage 管理权限(如 AliyunOTSFullAccess 或对应管控策略)。

  • 目标 AgentStorage 实例须存在且已至少绑定一个 VPC,知道其 AgentStorageName。

请求语法

GET /v2/openapi/listvpcinfobyagentstorage HTTP/1.1

请求参数

字段

类型

必填

说明

AgentStorageName

string

是

AgentStorage 名称。

PageNum

integer

否

页码。

PageSize

integer

否

每页返回的 VPC 数量。

响应

字段

类型

说明

RequestId

string

请求 ID。

PageNum

integer

当前页码。

PageSize

integer

当前分页大小。

TotalCount

integer

VPC 绑定总数。

AgentStorageName

string

AgentStorage 名称。

VpcInfos

array<object>

VPC 绑定列表。

VpcInfos[].VpcId

string

VPC ID。

VpcInfos[].Domain

string

VPC 访问域名。

VpcInfos[].AgentStorageVpcName

string

VPC 名称。

VpcInfos[].RegionNo

string

地域 ID。

VpcInfos[].Endpoint

string

实例连接地址。

{
  "RequestId": "39871ED2-62C0-578F-A32E-B88072D5582F",
  "PageNum": 1,
  "PageSize": 20,
  "TotalCount": 1,
  "AgentStorageName": "agent-prod",
  "VpcInfos": [
    {
      "VpcId": "vpc-example",
      "Domain": "http://prod-vpc-agent-prod.cn-beijing.vpc.ots.aliyuncs.com",
      "AgentStorageVpcName": "prod-vpc",
      "RegionNo": "cn-beijing",
      "Endpoint": "http://172.16.0.34:80/"
    }
  ]
}