调用DeleteSpareIps接口删除CNAME备用IP。
接口说明
- DeleteSpareIps 接口属于异步接口,即系统会先返回一个请求 ID,但 CNAME 备用 IP 并未删除完成,系统后台的删除任务仍在进行。您可以调用 DescribeAccelerator 接口查询全球加速实例的状态:
- 当全球加速实例处于 configuring 状态时,表示 CNAME 备用 IP 正在删除中,在该状态下,您只能执行查询操作,不能执行其他操作。
- 当全球加速实例处于 active 状态,且通过 ListSpareIps 接口已查询不到备用 IP 地址时,表示 CNAME 备用 IP 删除完成。
- DeleteSpareIps 接口不支持在同一个全球加速实例内并发删除 CNAME 备用 IP。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ga:DeleteSpareIps | delete |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
AcceleratorId | string | 是 | 全球加速实例 ID。 | ga-bp1odcab8tmno0hdq**** |
SpareIps | array | 是 | CNAME 备用 IP 列表,当加速区域异常时,流量切换到备用 IP。 您最多可以输入 2 个备用 IP。 | |
string | 是 | CNAME 备用 IP 列表,当加速区域异常时,流量切换到备用 IP。 您最多可以输入 2 个备用 IP。 | 127.0.XX.XX |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | NotExist.SpareIp | The spare ip %s doesn't exist. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史