Call the CreateDomain API to add a domain name - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

After you associate an accelerated domain name that has obtained an ICP number with a Global Accelerator (GA) instance, you do not need to complete filing for the accelerated domain name or its subdomains on Alibaba Cloud.

This operation adds an accelerated domain name and associates it with GA instances. Take note of the following items when calling this operation:

If your accelerated domain name is hosted in the Chinese mainland, you must obtain an ICP number for the domain name.
The same accelerated domain name cannot be repeatedly associated with the same GA instance.
You cannot repeatedly call the CreateDomain operation by using the same Alibaba Cloud account within a specific period of time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:CreateDomain

create

*Domain

acs:ga:{#regionId}:{#accountId}:ga/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
AcceleratorIds	array	Yes	The ID of the GA instance. You can enter up to 50 IDs.
	string	Yes	The ID of the GA instance. You can enter up to 50 IDs.	ga-bp1odcab8tmno0hdq****
Domain	string	Yes	The accelerated domain name to be added. Wildcard domain names are supported. A wildcard domain name must start with `.`, such as `.example.com`.	www.example.com
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, a 2xx HTTP status code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false

Response elements

Element	Type	Description	Example
	object	A list of response parameters.
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoIcpRecord.Domain	%s has not been put on ICP record.	%s has not been put on ICP record

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.