BindVPC-关联 VPC (全量操作)--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

BindVPC-关联 VPC (全量操作)

最近更新时间：2024.11.20 11:13:11首次发布时间：2023.02.08 13:11:14

将域名与 VPC 关联。该 API 为全量操作。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=BindVPC?Version=2022-06-01

请求参数

除了以下参数，您还需要对请求进行鉴权。

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`BindVPC`	API 的名称。该参数的取值是 `BindVPC`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。

Body

名称	类型	是否必选	示例值	描述
ZID	Integer	是	`1234`	标识域名的唯一 ID。您可以通过以下 API 获取：添加域名 API 获取域名列表 API
VPCs	JSON Object	是	`{"cn-beijing":["vpc-2d6si87atfh1c58ozfd0nzq8k"]}`	与域名关联的一个或多个 VPC。您需要绑定至少一个 VPC。BindVPC API 仅支持关联当前火山引擎账号下的 VPC。
VpcTrns	Array of strings	否	`["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]`	域名所关联的一个或多个 VPC 的 TRN。格式为 `trn:vpc:region:accountId:vpc/vpcId`。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

示例

请求示例

POST https://open.volcengineapi.com/?Action=BindVPC&Version=2022-06-01

{
    "ZID": 1013,
    "VPCs":{
        "cn-beijing":["vpc-2d6si87atfh1c58ozfd0nzq8k"]
        }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221214140553EC822FFD341E9C19EF59",
        "Action": "BindVPC",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn-beijing"
    }
}

错误码

您可访问公共错误码，获取详细信息。