创建路由目标组实例。
接口说明
-
CreateRouteTargetGroup 接口属于异步接口,即系统会返回一个实例 ID,但该路由目标组实例尚未创建完成,系统后台的创建任务仍在进行。您可以调用 ListRouteTargetGroup 查询路由目标组的创建状态:
- 当路由目标组处于 Pending 状态时,表示路由目标组创建中。
- 当路由目标组处于 Available、Unavailable、Switched、Abnormal 状态时,表示路由目标组创建完成。
-
主备模式:创建路由目标组时,需配置位于不同可用区、类型一致的主备实例。
-
主实例:权重为 100。正常情况下承载所有流量,在健康检查正常时生效。
-
备实例:权重为 0。主实例故障后接管流量,作为容灾备份。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:CreateRouteTargetGroup | create | *RouteTargetGroup acs:vpc:{#regionId}:{#accountId}:routetargetgroup/* |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| VpcId | string | 是 | 路由目标组所属的 VPC 的 ID。 | vpc-xxxx |
| RouteTargetGroupName | string | 否 | 路由目标组的名称。 名称长度为 1~128 个字符,不能以 http://或 https://开头。 | myRouteTargetGroupName |
| RouteTargetGroupDescription | string | 否 | 路由目标组的描述信息。 描述长度为 1~256 个字符,不能以 http://或 https://开头。 | myRouteTargetGroupDescription |
| RouteTargetMemberList | array<object> | 是 | 路由目标组的成员列表。 主备模式下,对路由目标组成员有如下限制:
| |
| object | 是 | |||
| MemberId | string | 是 | 路由目标组成员实例 ID。 | ep-xxxx |
| MemberType | string | 是 | 路由目标组的成员类型。 当前支持的类型:
主备模式下,路由目标组所有成员的类型必须相同。 | GatewayLoadBalancerEndpoint |
| Weight | integer | 是 | 路由目标组成员的权重值。取值:
权重值仅支持在创建时设置,不支持修改。 | 100 |
| ConfigMode | string | 是 | 路由目标组的配置模式,支持模式如下:
| Active-Standby |
| RegionId | string | 是 | 路由目标组所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
| ResourceGroupId | string | 否 | 资源组 ID。 关于资源组的更多信息,请参见什么是资源组。 | rg-acfmxazffggds**** |
| ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。 | 0c593ea1-3bea-11e9-b96b-88e9fe6**** |
| Tag | array<object> | 否 | 资源的标签。 | |
| object | 否 | 资源的标签。 | ||
| Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。 一个标签键最多支持 128 个字符,不能以 | FinanceDept |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。 最多支持 128 个字符,不能以 | FinanceJoshua |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "8AA5CE21-2E6A-4530-BDF5-F055849476E6",
"RouteTargetGroupId": "rtg-xxxx"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | UnsupportedFeature.RouteTargetGroup | The feature of RouteTargetGroup is not supported. | 当前地域不支持路由目标组功能。 |
| 400 | Mismatch.GroupVpcIdAndInstanceVpcId | The RouteTargetGroup VPC %s and the RouteTargetConfig VPC %s are mismatched. | 路由目标组所属的VPC和路由目标配置实例所属的VPC不一致。 |
| 400 | OperationDenied.MemberWithSameAz | The operation is not allowed because of all members being in the same availability zone. | 路由目标组成员实例禁止属于同一个可用区。 |
| 400 | InvalidVpcId.NotFound | Specified value of VpcId is not found in our record. | 该VPC不存在,请您检查输入的VPC是否正确。 |
| 400 | ResourceNotFound.GatewayLoadBalancerEndpoint | GatewayLoadBalancerEndpoint instance %s not found. | - |
| 400 | QuotaExceeded.RouteTargetGroup | The quota of %s is exceeded, usage %s/%s. | 已超出VPC内支持创建的路由目标组最大数量,请提升配额后操作。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-01-04 | 新增 OpenAPI | 查看变更详情 |
