调用CreateSpareIps创建CNAME备用IP_全球加速(GA)-阿里云帮助中心

调用CreateSpareIps接口创建CNAME备用IP，当加速区域异常时，流量可切换到备用IP。

接口说明

CreateSpareIps 接口属于异步接口，即系统会先返回一个请求 ID，但 CNAME 备用 IP 并未创建完成，系统后台的创建任务仍在进行。您可以调用 DescribeAccelerator 查询全球加速实例的状态：
- 当全球加速实例处于 configuring 状态时，表示全球加速实例的 CNAME 备用 IP 正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。
- 当全球加速实例处于 active 状态时，表示全球加速实例的 CNAME 备用 IP 创建完成。
CreateSpareIps 接口不支持在同一个全球加速实例内并发创建 CNAME 备用 IP。

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

操作	访问级别	资源类型	条件关键字	关联操作
ga:CreateSpareIps	create	Accelerator acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}	无	无

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所在的地域 ID，仅取值：cn-hangzhou。	cn-hangzhou
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRun	boolean	否	是否只预检此次请求，取值： true：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	true
AcceleratorId	string	是	全球加速实例 ID。	ga-bp1odcab8tmno0hdq****
SpareIps	array	是	CNAME 备用 IP 列表，当加速区域异常时，流量切换到备用 IP。您最多可以输入 2 个备用 IP。
	string	是	CNAME 备用 IP 列表，当加速区域异常时，流量切换到备用 IP。您最多可以输入 2 个备用 IP。	127.0.XX.XX

名称	类型	描述	示例值
	object	返回信息列表。
RequestId	string	请求 ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8

正常返回示例

JSON格式

{
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}

HTTP status code	错误码	错误信息
400	Duplicate.SpareIp	The spare IP address is duplicate.
400	AlreadyExist.SpareIp	The spare ip %s already exists.
400	IllegalParamFormat.SpareIp	The param format of spare ip is illegal.
400	QuotaExceeded.SpareIp	The number of spare ip exceeds the limit.
400	TooManySpareIp.Accelerator	Too many SpareIp accepted under the same Accelerator.
400	NoPermission.CreateSpareIp	You do not have permission to create spareIp.

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

变更时间	变更内容概要	操作
2023-04-20	OpenAPI 错误码发生变更	查看变更详情