CreateIpv6Gateway--IPv6网关-火山引擎

文档中心

立即注册

导航

CreateIpv6Gateway

最近更新时间：2023.09.05 08:16:35首次发布时间：2022.10.10 09:46:29

调用 CreateIpv6Gateway 接口，创建一个IPv6网关实例。

调用说明

当VPC开启IPv6时，系统会自动为其创建一个IPv6网关。
一个IPv6网关仅支持关联一个私有网络，一个私有网络仅支持关联一个IPv6网关。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	CreateIpv6Gateway	要执行的操作，取值为CreateIpv6Gateway。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
VpcId	String	是	vpc-bp1opxu1zkhn00gz****	需关联IPv6网关实例的VPC ID。您可以调用 DescribeVpcs 接口，查询VPC的ID。说明每个VPC只能关联一个IPv6网关实例，需确保待关联的VPC未关联其他IPv6网关实例。
Name	String	否	ipv6GW-01	IPv6网关实例的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为IPv6网关ID。
Description	String	否	ipv6gatewayforVPC1	IPv6网关实例的描述信息。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
ClientToken	String	否	0c593ea1-3bea-11e9-b96b-88e9fe63****	客户端Token，用于保证请求的幂等性。该参数值由客户端自动生成，确保不同请求的取值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值仅支持ASCII字符，最大不超过64个字符。未指定该参数值时，不进行幂等校验。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
Ipv6GatewayId	String	ipv6gw-hp3y0l3ln89j8cdvf****	新创建的IPv6网关实例的ID。

请求示例

GET /?Action=CreateIpv6Gateway&Version=2020-04-01&VpcId=vpc-bp1opxu1zkhn00gz****&Name=ipv6GW-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: vpc

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "CreateIpv6Gateway",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-guangzhou"
    }, 
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8cdvf****"
    }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400	InvalidVpc.InvalidStatus	The specified VPC is not in the correct status for the request.	指定的VPC所处状态无法响应该请求。
400	OperationFailed.VpcIpv6Disabled	Operation failed because vpc IPv6 is not enabled.	VPC未开启IPv6。
400	OperationUnsupported.OnlyOneIpv6GatewayInVpc	Create more than one IPv6 gateway in vpc is unsupported.	一个VPC中只能创建一个IPv6网关。
403	Forbidden	You are not authorized to perform operations on create IPv6 gateway.	无权限创建IPv6网关。
404	InvalidVpc.NotFound	The specified VPC does not exist.	指定的VPC不存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。