Help Center/ Global Accelerator/ API Reference/ API/ Global Accelerator/ Querying Details of a Global Accelerator
Updated on 2024-11-11 GMT+08:00

Querying Details of a Global Accelerator

Function

This API is used to query details of a global accelerator.

Calling Method

For details, see Calling APIs.

URI

GET /v1/accelerators/{accelerator_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

accelerator_id

Yes

String

Specifies the global accelerator ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

accelerator

AcceleratorDetail object

Specifies the global accelerator.

request_id

String

Specifies the request ID.

Table 4 AcceleratorDetail

Parameter

Type

Description

id

String

Specifies the global accelerator ID.

name

String

Specifies the global accelerator name. The name can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.

description

String

Specifies the description about the global accelerator. The value can contain 0 to 255 characters. The following characters are not allowed: <>

status

String

Specifies the provisioning status. The value can be one of the following:

  • ACTIVE: The resource is running.

  • PENDING: The status is to be determined.

  • ERROR: Failed to create the resource.

  • DELETING: The resource is being deleted.

ip_sets

Array of AccelerateIp objects

Specifies the IP addresses assigned to the global accelerator.

created_at

String

Specifies when the global accelerator was created.

updated_at

String

Specifies when the global accelerator was updated.

domain_id

String

Specifies the tenant ID.

enterprise_project_id

String

Specifies the enterprise project ID of the tenant.

flavor_id

String

Specifies the specification ID.

frozen_info

FrozenInfo object

Specifies the frozen details of cloud services or resources.

tags

Array of ResourceTag objects

Specifies the tags.

Table 5 AccelerateIp

Parameter

Type

Description

ip_type

String

Specifies the IP address version.

ip_address

String

Specifies the IP address.

area

String

Specifies the acceleration area. The value can be one of the following:

  • OUTOFCM: Outside the Chinese mainland

  • CM: Chinese mainland

Table 6 FrozenInfo

Parameter

Type

Description

status

Integer

Specifies the status of a cloud service or resource. The value can be one of the following:

  • 0: unfrozen/normal (The cloud service will recover after being unfrozen.)

  • 1: frozen (Resources and data will be retained, but the cloud service cannot be used.)

  • 2: deleted/terminated (Both resources and data will be cleared.)

effect

Integer

Specifies the status of the resource after being frozen. The value can be one of the following:

  • 1 (default): The resource is frozen and can be released.

  • 2: The resource is frozen and cannot be released.

  • 3: The resource is frozen and cannot be renewed.

scene

Array of strings

Specifies the service scenario. The value can be one of the following:

  • ARREAR: The cloud service is in arrears, including expiration of yearly/monthly resources and fee deduction failure of pay-per-use resources.

  • POLICE: The cloud service is frozen for public security.

  • ILLEGAL: The cloud service is frozen due to violation of laws and regulations.

  • VERIFY: The cloud service is frozen because the user fails to pass the real-name authentication.

  • PARTNER: A partner freezes their customer's resources.

Table 7 ResourceTag

Parameter

Type

Description

key

String

Specifies the tag key. The key must meet the following requirements:

  • The key can contain 1 to 128 characters.

  • The key can contain UTF-8 letters, digits, spaces, and the following characters:_.:=+-@

  • Tags starting with _sys_ are system tags and cannot be entered by tenants.

value

String

Specifies the tag value. The value must meet the following requirements:

  • The value can contain 0 to 255 characters.

  • The key can contain UTF-8 letters, digits, spaces, and the following characters:_.:/=+-@

  • The value can be empty or null.

Example Requests

Querying details of a global accelerator

GET https://{ga_endpoint}/v1/accelerators/ac1bf54f-6a23-4074-af77-800648d25bc8

Example Responses

Status code: 200

Operation succeeded.

{
  "accelerator" : {
    "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"
    } ]
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

Status Codes

Status Code

Description

200

Operation succeeded.

Error Codes

See Error Codes.