Creating a Global Accelerator

Function

This API is used to create a global accelerator.

Calling Method

For details, see Calling APIs.

URI

POST /v1/accelerators

Request Parameters

**Table 1** 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.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
accelerator	Yes	CreateAcceleratorOption object	Specifies the detailed information about creating a global accelerator.

**Table 3** CreateAcceleratorOption
Parameter	Mandatory	Type	Description
name	Yes	String	Specifies the global accelerator name. The name can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.
description	No	String	Specifies the description about the global accelerator. The value can contain 0 to 255 characters. The following characters are not allowed: <>
ip_sets	Yes	Array of ip_sets objects	Specifies the IP addresses assigned to the global accelerator.
enterprise_project_id	Yes	String	Specifies the enterprise project ID of the tenant. The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.
tags	No	Array of ResourceTag objects	Specifies the tags.

**Table 4** ip_sets
Parameter	Mandatory	Type	Description
ip_type	Yes	String	Specifies the IP address version. The value can be IPv4 or IPv6.
area	Yes	String	Specifies the acceleration area. The value can be one of the following: OUTOFCM: Outside the Chinese mainland CM: Chinese mainland

**Table 5** ResourceTag
Parameter	Mandatory	Type	Description
key	Yes	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	Yes	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.

Response Parameters

Status code: 201

**Table 6** Response body parameters
Parameter	Type	Description
accelerator	AcceleratorDetail object	Specifies the global accelerator.
request_id	String	Specifies the request ID.

**Table 7** 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 8** 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 9** 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 10** 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

Creating a global accelerator outside the Chinese mainland with an IPv4 address

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

{
  "accelerator" : {
    "name" : "acceleratorName",
    "description" : "accelerator description",
    "ip_sets" : [ {
      "ip_type" : "IPV4",
      "area" : "OUTOFCM"
    } ],
    "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
    "tags" : [ {
      "key" : "tagKey",
      "value" : "tagValue"
    } ]
  }
}

Example Responses

Status code: 201

Global accelerator created.

{
  "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"
}