文档首页/ 全球加速 GA/ API参考/ API/ 全球加速实例/ 查询全球加速器列表
更新时间：2024-11-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询全球加速器列表

功能介绍

查询全球加速器列表。

调用方法

请参见如何调用API。

URI

GET /v1/accelerators

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

分页查询每页的资源个数。如果不设置，则默认为500。

marker

否

String

分页查询的起始的资源ID，表示上一页最后一条查询资源记录的ID。不指定时表示查询第一页。

必须与limit一起使用。

page_reverse

否

Boolean

分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。

id

否

String

资源ID。

name

否

String

资源名称，取值范围：0~64个字符之间，只能由数字、字母、中划线和中文组成。

status

否

String

配置状态，可选范围:

  • ACTIVE：运行中

  • PENDING：待定

  • ERROR：错误

  • DELETING：正在删除

enterprise_project_id

否

String

租户的企业项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

accelerators

Array of AcceleratorDetail objects

全球加速器列表。

page_info

PageInfo object

分页查询页的信息。

request_id

String

请求ID。
表4 AcceleratorDetail

参数

参数类型

描述

id

String

全球加速器ID。

name

String

全球加速器名称，取值范围：1~64个字符之间，只能由数字、字母、中划线和中文组成。

description

String

全球加速器描述信息，取值范围：0~255个字符之间，禁止输入字符：<>。

status

String

配置状态，取值：

  • ACTIVE：运行中

  • PENDING：待定

  • ERROR：错误

  • DELETING：正在删除

ip_sets

Array of AccelerateIp objects

全球加速器IP列表。

created_at

String

创建时间。

updated_at

String

更新时间。

domain_id

String

租户ID。

enterprise_project_id

String

租户的企业项目ID。

flavor_id

String

规格ID。

frozen_info

FrozenInfo object

云服务或资源实例冻结信息。

tags

Array of ResourceTag objects

标签列表。
表5 AccelerateIp

参数

参数类型

描述

ip_type

String

IP地址类型。

ip_address

String

IP地址。

area

String

地区，取值：

  • OUTOFCM：中国大陆以外

  • CM：中国大陆
表6 FrozenInfo

参数

参数类型

描述

status

Integer

云服务或资源实例状态，取值：

  • 0：解冻/正常（云服务恢复正常）。

  • 1：冻结（资源和数据会保留，但租户无法再正常使用云服务）。

  • 2：删除/终止（资源和数据将清除）。

effect

Integer

在冻结/解冻操作下，取值：

  • 1（默认值）：冻结可释放。

  • 2：冻结不可释放。

  • 3：冻结后不可续费。

scene

Array of strings

更新云服务状态的业务场景列表，取值：

  • ARREAR（默认值）：欠费场景。为正常的运营业务场景，包括包周期资源到期、按需资源扣费失败。

  • POLICE：公安冻结场景。

  • ILLEGAL：违规冻结场景。

  • VERIFY：客户未实名认证冻结场景。

  • PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。
表7 ResourceTag

参数

参数类型

描述

key

String

标签键，规则：

  • 1.key不能为空，长度1~128个字符（中文也可以输入128个字符）。

  • 2.可用 UTF-8 格式表示的字母（包含中文）、数字和空格，以及以下字符_ . : = + - @。

  • 3._sys_开头属于系统标签，租户不能输入。

value

String

标签值，规则：

  • 1.长度0~255个字符（中文也可以输入255个字符）。

  • 2.可用 UTF-8 格式表示的字母（包含中文）、数字和空格，以及以下字符_ . : / = + - @。

  • 3.资源标签值可以为空（empty or null）。
表8 PageInfo

参数

参数类型

描述

next_marker

String

下一页的marker，为空时表示最后一页。

current_count

Integer

当前列表中资源数量。

请求示例

查询全球加速器列表

GET https://{ga_endpoint}/v1/accelerators

响应示例

状态码： 200

操作成功

{
  "accelerators" : [ {
    "id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
    "name" : "acceleratorName",
    "description" : "accelerator description",
    "status" : "ACTIVE",
    "ip_sets" : [ {
      "ip_type" : "IPV4",
      "ip_address" : "208.188.100.1",
      "area" : "OUTOFCM"
    } ],
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
    "flavor_id" : "00000000-0000-0000-0000-000000000000",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    },
    "tags" : [ {
      "key" : "tagKey",
      "value" : "tagValue"
    } ]
  } ],
  "page_info" : {
    "next_marker" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
    "current_count" : 1
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

状态码

状态码

描述

200

操作成功

错误码

请参见错误码。

父主题： 全球加速实例

相关文档