调用GetSpareIp接口查询CNAME备用IP的状态。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ga:GetSpareIp | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 全球加速实例所在的地域 ID，仅取值：cn-hangzhou。 | cn-hangzhou |
| ClientToken | string | 否 | 保证请求幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 | 1F4B6A4A-C89E-489E-BAF1-52777EE148EF |
| DryRun | boolean | 否 | 是否只预检此次请求，取值：
| true |
| AcceleratorId | string | 是 | 全球加速实例 ID。 | ga-bp1odcab8tmno0hdq**** |
| SpareIp | string | 是 | CNAME 备用 IP，当加速区域异常时，流量切换到该 IP。 | 47.100.XX.XX |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
"State": "active"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | NoPermission | No permissions. | 无权限 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-23 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-03-31 | API 内部配置变更，不影响调用 | 查看变更详情 |