You need to enable JavaScript to run this app.
导航
BindRuleVPC - 转发规则关联 VPC
最近更新时间:2025.05.22 20:13:39首次发布时间:2023.06.26 20:59:38
我的收藏
有用
有用
无用
无用

为转发规则关联 VPC。转发规则在关联的 VPC 中生效。

使用说明

请求频率:每秒最多调用 10 次。

请求说明

  • 请求方式:GET
  • 请求地址:https://private-zone.volcengineapi.com/?Action=BindRuleVPC?Version=2022-06-01

调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

BindRuleVPC

要执行的操作,取值:BindRuleVPC。

Version
String

2022-06-01

API的版本,取值:2022-06-01。

RuleTrn
String

trn:private_zone::21******4::rule/rule-1234

转发规则的 TRN。格式为 trn:private_zone::accountId::rule/rule-ruleId。如果您需要验证子用户是否对转发规则所在的项目有操作权限,您需要传入该参数。

RuleID
Long

123

转发规则的 ID。您可以从以下 API 的响应中获取:

VpcTrns
Array of String

["trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"]

转发规则所关联的一个或多个 VPC 的 TRN。格式为 trn:vpc:region:accountId:vpc/vpcId。如果您需要验证子用户是否对转发规则所关联的 VPC 所在的项目有操作权限,您需要传入该参数。

Vpcs
Array of Object

与域名绑定的一个或多个 VPC。您需要绑定至少一个 VPC。您添加的地域必须和终端节点所在的地域相同。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

POST https://private-zone.volcengineapi.com/?Action=BindRuleVPC&Version=2022-06-01

{
  "RuleID": 123,
  "Vpcs": [
    {
      "VpcId": "vpc-2d6si87atfh1c58ozfd0nzq8k",
      "Region": "cn-beijing"
    }
  ]
}
json

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230614140553EC822FFD341E9C19EF59",
        "Action": "BindRuleVPC",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    }
}
json

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
ErrVniConflict

vpc deleted while zone retained leads to vni conflict

删除vpc时没有删除zone导致vni冲突

400
ErrVPCUniqKey

zone already exists in %s

域名已经关联过该vpc

400
ErrSystemRule

modify system rule is not allowed

系统规则禁止修改

400
ErrRuleNotFound

resolver rule not found

未找到转发规则

400
ErrNoVPCSpecified

at least one vpc should be specified

未关联VPC

400
ErrEndpointNotFound

resolver endpoint not found

未找到转发终端节点

400
ErrParamInvalid

validation fail: params:[%s] , value:[%v]

参数校验失败

500
ErrInternalServer

server internal error

服务内部错误