云原生消息引擎
云原生消息引擎
云原生消息引擎
文档指南
请输入
产品动态
BMQ 实例用户指南
控制台指南
实例管理
SDK 参考
API 参考
实例管理
实例连接管理
Topic 管理
MQTT 实例用户指南
控制台指南
MQTT Agent
API 参考
MQTT密钥
Dashboard指南
访问控制
- 文档首页
云原生消息引擎BMQ 实例用户指南API 参考实例连接管理ListAvailableVPCForBMQ - 查询可用 VPC 列表
复制全文
下载 pdfListAvailableVPCForBMQ - 查询可用 VPC 列表
文档反馈
问问助手调用 ListAvailableVPCForBMQ 接口，获取可用的私有网络 VPC 列表。
Request URL
GET https://open.volcengineapi.com?Action=ListAvailableVPCForBMQ&Version=2023-06-01
请求参数-Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 否 | o-00g00*** | 支持指定目标 BMQ 实例 ID，获取该实例可用的 VPC 列表。 |
VpcIds | String | 否 | vpc-rroo4x** | 支持指定 VPC ID，获取该 VPC 的状态、子网、安全组等信息。 支持同时设置多个 VPC ID，使用英文逗号（,）分隔。 |
Keyword | String | 否 | vpc-10-autotest | 支持指定 VPC 的名称，获取该 VPC 的状态、子网、安全组等信息。 |
MaxResults | Integer | 否 | 10 | 单次查询返回的 VPC 结果条数。默认为 10 条，最大值为 100条。 |
NextToken | String | 否 | InZwYy1ycmlxaWo4e**5biI= | 查询时，会返回一个分页查询 Token，用于标记分页位置。 在下次查询请求中填写该 Token，则从分页位置开始查询并返回。 |
返回参数
参数 | 类型 | 示例值 | 说明 |
参数 | 类型 | 示例值 | 说明 |
Items | - | VPC 数据列表。 | |
NextToken | String | InZwYy1ycm9vNHg3azlz***OCI= | 查询时，会返回一个分页查询 Token，用于标记分页位置。 在下次查询请求中填写该 Token，则从分页位置开始查询并返回。 |
VPCItemResponse
参数 | 类型 | 示例值 | 说明 |
参数 | 类型 | 示例值 | 说明 |
Name | String | vpc-10-autotest | VPC 名称。 |
VpcId | String | vpc-rroo4x7k9s** | VPC ID。 |
Status | String | Available | VPC 状态。 |
CidrBlock | StringString | 10.0.0.0/8 | 私有网络的 IPv4 地址范围。 |
SubnetIds | Array of String | ["subnet-1","subnet-2"] | 子网 ID 列表。 |
CreateTime | String | 2022-06-23T17:07:24 | VPC 创建时间。 |
Description | String | 测试VPC | VPC 描述信息。 |
SecurityGroupIds | Array of String | ["sg-1","sg-2"] | 安全组 ID 列表。 |
请求示例
GET https://open.volcengineapi.com?Action=ListAvailableVPCForBMQ&Version=2023-06-01&{InstanceId}&{MaxResults}
Content-Type: application/json
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/bmq/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***
返回示例
{
"ResponseMetadata": {
"RequestId": "202402291407413DEAC859***",
"Action": "ListAvailableVPCForBMQ",
"Version": "2023-06-01",
"Service": "BMQ",
"Region": "cn-beijing"
},
"Result": {
"Items": [
{
"VpcId": "vpc-rs3m485e28e***",
"Name": "vpc-gjli-1-11",
"Status": "Available",
"CidrBlock": "192.168.0.0/16",
"Description": "",
"SubnetIds": [
"subnet-rs3m4xssiy2ov***"
],
"SecurityGroupIds": [
"sg-rs3m4e2heebkv0x***"
],
"CreateTime": "2022-09-16T15:52:46"
},
{
"VpcId": "vpc-rroo4x7k9slcv0x***",
"Name": "vpc-10-autotest",
"Status": "Available",
"CidrBlock": "10.0.0.0/8",
"Description": "",
"SubnetIds": [
"subnet-13f2u1ryd8pog3n6**",
"subnet-rry37vgrwk5cv0x**"
],
"SecurityGroupIds": [
"sg-13f2418gdnrpc3n6**",
"sg-rs7ef769g0sgv0x57**"
],
"CreateTime": "2022-06-23T17:07:24"
}
],
"NextToken": "InZwYy1ycm9vNHg3azlz***a25tOCI="
}
}
最近更新时间：2025.08.05 18:34:38
这个页面对您有帮助吗？
有用
有用
无用
无用