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

Operation description

Global Accelerator provides a China Ministry of Industry and Information Technology (MIIT) ICP filing exemption service for accelerated domain names on Alibaba Cloud. You only need to associate an accelerated domain name that has completed ICP filing with a Global Accelerator instance. Global Accelerator then exempts the accelerated domain name and all subdomains under its primary domain name from Alibaba Cloud ICP filing requirements.

This operation adds an accelerated domain name to associate it with a Global Accelerator instance. Before you invoke this operation, take note of the following items:

If the accelerated domain name is deployed in the Chinese mainland, ICP filing must be completed.
The same accelerated domain name cannot be associated with the same Global Accelerator instance more than once.
The CreateDomain operation does not support concurrently adding accelerated domain names within the same account.

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 region ID of the Global Accelerator instance. Set the value to cn-hangzhou.	cn-hangzhou
AcceleratorIds	array	Yes	The Global Accelerator instance ID. You can specify up to 50 GA instance IDs.
	string	Yes	The Global Accelerator instance ID. You can specify up to 50 GA instance IDs.	ga-bp1odcab8tmno0hdq****
Domain	string	Yes	The accelerated domain name to add. Only primary domain names are supported, such as `example.com`.	example.com
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a check request without creating the resource. The system checks the required parameters, request format, and business limits. If the check fails, the corresponding error is returned. If the check passes, an HTTP 2xx status code is returned. false (default): Sends a normal request. After the check passes, an HTTP 2xx status code is returned and the operation is performed.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	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.