文档

CreateIpv6EgressOnlyRule - 为IPv6地址添加仅主动出规则

更新时间:
一键部署

您可以通过创建仅主动出规则,使开通了IPv6网段的VPC中的ECS可以主动访问客户端的IPv6终端,但不允许客户端的IPv6终端通过互联网访问VPC网络中的ECS实例,调用CreateIpv6EgressOnlyRule为IPv6地址添加仅主动出规则。

接口说明

  • CreateIpv6EgressOnlyRule 接口属于异步接口,即系统返回一个实例 ID,但该 IPv6 地址的仅主动出规则尚未创建成功,系统后台的创建任务仍在进行。您可以调用 DescribeIpv6EgressOnlyRules 查询 IPv6 地址的仅主动出规则的创建状态:
    • 当 IPv6 地址的仅主动出规则处于 Creating 状态时,表示 IPv6 地址仅主动出规则正在创建中。
    • 当 IPv6 地址的仅主动出规则处于 Created 状态时,表示 IPv6 地址仅主动出规则创建完成。
  • CreateIpv6EgressOnlyRule 接口不支持为同一个 IPv6 地址并发添加仅主动出规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:CreateIpv6EgressOnlyRuleWrite
  • Ipv6EgressRule
    acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}

请求参数

名称类型必填描述示例值
RegionIdstring

IPv6 网关的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-huhehaote
Ipv6GatewayIdstring

IPv6 网关实例 ID。

ipv6gw-hp3c2paq0ywauasza****
InstanceIdstring

需要设置仅主动出规则的 IPv6 地址 ID。

ipv6-hp3nxjkfxn5pnhgl5****
InstanceTypestring

需要设置仅主动出规则的实例类型。

仅取值:Ipv6Address(默认值),表示为 IPv6 地址类型。

Ipv6Address
Namestring

仅主动出规则的名称。

长度为 2~128 个字符,必须以字母或中文开头,可包含数字、下划线(_)和短划线(-),开头不能为http://https://

rulename
Descriptionstring

仅主动出规则的描述。

长度为 2~256 个字符,开头不能为http://https://

ruledescription
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
0c593ea1-3bea-11e9-b96b-88e9fe637760

返回参数

名称类型描述示例值
object
Ipv6EgressRuleIdstring

仅主动出规则的 ID。

ipv6py-hp3w98rmlbqp01245****
RequestIdstring

请求 ID。

9DFEDBEE-E5AB-49E8-A2DC-CC114C67AF75

示例

正常返回示例

JSON格式

{
  "Ipv6EgressRuleId": "ipv6py-hp3w98rmlbqp01245****",
  "RequestId": "9DFEDBEE-E5AB-49E8-A2DC-CC114C67AF75"
}

错误码

HTTP status code错误码错误信息描述
400InvalidIpv6Gateway.NotFound%s-
400IllegalParam.Name%s-
400IllegalParam.Description%s-
400IllegalParam.InstanceType%s-
400OperationFailed.FinancialLocked%s-
400OperationUnsupported.EgressRuleVSwitch%s-
400InvalidIpv6Instance.NotFound%s-
400OperationFailed.NoInternetBandwidth%s-
400OperationFailed.Ipv6EgressRuleExistedAn egress-only rule already exists for the IPv6 address.该ipv6实例已存在仅主动出规则。
400OperationFailed.InternetBandwidthUnstable%s-
400IncorrectStatus.Ipv6InternetBandwidth%s-
400OperationUnsupported.EgressRuleInDefaultSpec%s-
400QuotaExceeded.Ipv6EgressRules%s-
400Mismatch.Ipv6AddressAndIpv6GatewayThe %s and %s are mismatched.指定的Ipv6Address和Ipv6Gateway不在同一VPC内
400OperationUnsupported.EgressOnlyRuleOnFreeIpv6InstanceCreating ipv6 egress only rule on ipv6 instance that not associated with any resource is unsupported.不支持在未绑定资源的IPv6实例上创建仅主动出规则
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-28OpenAPI 错误码发生变更查看变更详情
2023-10-10OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-07-05OpenAPI 错误码发生变更查看变更详情