IPv6网关是控制专有网络VPC(Virtual Private Cloud)的IPv6网络流量的网关。您可以通过调用CreateIpv6Gateway接口创建IPv6网关。
接口说明
-
创建 IPv6 网关之前,请确保目标 VPC 和交换机已开通 IPv6 网段能力,您可以调用 DescribeVpcAttribute ,查询 VPC 的配置信息。
-
一个 VPC 内仅允许创建一个 IPv6 网关。
-
CreateIpv6Gateway 接口属于异步接口,即系统返回一个实例 ID,但该 IPv6 网关尚未创建成功,系统后台的启动任务仍在进行。您可以调用 DescribeIpv6GatewayAttribute 查询 IPv6 网关的创建状态:
- 当 IPv6 网关处于 Creating 状态时,表示 IPv6 网关正在创建中。
- 当 IPv6 网关处于 Created 状态时,表示 IPv6 网关创建完成。
-
CreateIpv6Gateway 接口不支持在同一个 VPC 下并发创建 IPv6 网关。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:CreateIpv6Gateway | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | IPv6 网关的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-huhehaote |
VpcId | string | 是 | 要开通 IPv6 网关的 VPC ID。 | vpc-123sedrfswd23**** |
Name | string | 否 | IPv6 网关的名称。 长度为 0-128 个字符,不能以 | ipv6GW |
Description | string | 否 | IPv6 网关的描述信息。 长度为 0-256 个字符,不能以 | ipv6gatewayforVPC1 |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
ResourceGroupId | string | 否 | IPv6 网关所属的资源组 ID。 关于资源组的更多信息,请参见什么是资源组。 | rg-acfmxazb4ph6aiy**** |
Tag | array<object> | 否 | 资源的标签。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。 一个标签键最多支持 128 个字符,不能以 | FinanceDept |
Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。 最多支持 128 个字符,不能以 | FinanceJoshua |
返回参数
示例
正常返回示例
JSON
格式
{
"Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8cdvf****",
"ResourceGroupId": "rg-acfmxazb4ph6aiy****",
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidVpcId.NotFound | %s | - |
400 | IllegalParam.Name | %s | - |
400 | IllegalParam.Description | %s | - |
400 | IllegalParam.Spec | %s | - |
400 | IllegalParam.ChargeType | %s | - |
400 | OperationUnsupported.OnlyOneIpv6GatewayInVpc | %s | - |
400 | OperationFailed.VpcIpv6Disabled | %s | - |
400 | OperationFailed.UnpaidBillsExist | The account has unpaid bills. Please pay your overdue bill first. | 此账户有未支付的订单。 |
400 | OperationFailed.InformationIncomplete | Your information is incomplete. | 输入信息不完整。 |
400 | OperationFailed.NoPaymentMethod | No payment method is specified for your account. | 账户中没有有效的支付方式。 |
400 | IllegalParam.ResourceGroupId | Invalid ResourceGroupld value. | 指定的资源组非法或不存在 |
400 | MissingParam.vpcId | The parameter vpcId is mandatory. | 参数缺失,vpcId是必选参数 |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
404 | InvalidVpcId.NotFound | Specified VPC does not exist. | 该VPC不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-07-05 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |