全部产品
Search

搜索本产品

    全球加速：GetSpareIp - 查询CNAME备用IP的状态

    文档中心

    全球加速：GetSpareIp - 查询CNAME备用IP的状态

    更新时间：Jul 31, 2024

    调用GetSpareIp接口查询CNAME备用IP的状态。

    调试

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

    授权信息

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

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

    请求参数

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

    全球加速实例所在的地域 ID，仅取值：cn-hangzhou。

    		cn-hangzhou
    ClientTokenstring否

    保证请求幂等性。

    从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

    		1F4B6A4A-C89E-489E-BAF1-52777EE148EF
    DryRunboolean否

    是否只预检此次请求，取值：

    • true：发送检查请求，不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
    • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。
    		true
    AcceleratorIdstring是

    全球加速实例 ID。

    		ga-bp1odcab8tmno0hdq****
    SpareIpstring是

    CNAME 备用 IP，当加速区域异常时，流量切换到该 IP。

    		47.100.XX.XX

    返回参数

    名称类型描述示例值
    object

    返回信息列表。

    RequestIdstring

    请求 ID。

    		6FEA0CF3-D3B9-43E5-A304-D217037876A8
    Statestring

    CNAME 备用 IP 的状态。取值：

    • active：可用。
    • inuse：使用中。
    		active

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400NoPermissionNo permissions.无权限

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

    变更历史

    变更时间变更内容概要操作
    2024-07-23OpenAPI 错误码发生变更查看变更详情
    2023-03-31API 内部配置变更，不影响调用查看变更详情