You need to enable JavaScript to run this app.
文档中心
云原生消息引擎

云原生消息引擎

复制全文
下载 pdf
实例连接管理
ListAvailableVPCForBMQ - 获取对 BMQ 可用的 VPC 列表
复制全文
下载 pdf
ListAvailableVPCForBMQ - 获取对 BMQ 可用的 VPC 列表
调用 ListAvailableVPCForBMQ 接口,获取对 BMQ 可用的 VPC 列表。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListAvailableVPCForBMQ​
要执行的操作,取值:ListAvailableVPCForBMQ。​
​
Version string 必选 示例值:2023-06-01​
API的版本,取值:2023-06-01。​
​
ProjectName string 必选 示例值:just_for_test​
项目名称。​
​
VpcIds string[] 可选 示例值:vpc-****​
VPC ID 列表。​
​
Name string 可选 示例值:test​
VPC 名称。​
​
InstanceId string 可选 示例值:test_ht99k3**​
Instance ID。​
​
MaxResults integer 可选 示例值:5​
单次查询的数量, 最大为 100。​
​
NextToken string 可选 示例值:testonly​
分页查询凭证,用于标记分页的位置, 不填则从头开始查询。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Items object[] 示例值:/​
VPC 数据列表。​
Name string 示例值:test**​
VPC 名称。​
​
VpcId string 示例值:vpc-****​
VPC ID。​
​
Status string 示例值:Available​
VPC 状态。​
​
CidrBlock string 示例值:10.0.0.0/8​
私有网络的 IPv4 地址范围。​
​
SubnetIds string[] 示例值:["subnet-1","subnet-2"]​
子网 ID 列表。​
​
CreateTime string 示例值:2023-06-01T00:00:00​
VPC 创建时间。​
​
Description string 示例值:test_only​
VPC 描述。​
​
SecurityGroupIds string[] 示例值:subnet-****​
安全组 ID 列表。​
​
​
NextToken string 示例值:justfortest​
下次分页查询依据。​
​
​
​
请求示例​
​
POST /?Action=ListAvailableVPCForBMQ&Version=2023-06-01 HTTP/1.1​
Host: bmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260211T034749Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260211/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"ProjectName": "just_for_test"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2026021***89029088172078BEC053",​
"Action": "ListAvailableVPCForBMQ",​
"Version": "2023-06-01",​
"Service": "bmq",​
"Region": "cn-beijing"​
},​
"Result": {​
"Items": [​
{​
"Name": "test**",​
"VpcId": "vpc-****",​
"Status": "Available",​
"CidrBlock": "10.0.0.0/8",​
"SubnetIds": [​
"subnet-1",​
"subnet-2"​
],​
"CreateTime": "2023-06-01T00:00:00",​
"Description": "test_only",​
"SecurityGroupIds": [​
"subnet-****"​
]​
}​
],​
"NextToken": "justfortest"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
200​
InvalidParameter​
parameter is invalid, pls check parameters​
参数值无效。​
200​
Unauthorized​
authorized error​
授权错误,请授权或切换账号后重试。​
200​
InternalServiceError​
internal service error, please contact with admin​
内部服务错误,请联系技术支持或提交工单。​
200​
DatabaseError​
database error​
数据库错误。​
200​
ParameterEncodingError​
Failure encoding object into query map​
参数编码异常,请联系技术支持或提交工单。​
​
​
最近更新时间:2026.02.11 14:11:36
这个页面对您有帮助吗?
有用
有用
无用
无用