Enable Custom Domain Routing for API Groups with SetDomain - API Gateway

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

apigateway:SetDomain

update

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the API group. This ID is generated by the system and globally unique.	927d50c0f2e54b359919923d908bb015
DomainName	string	Yes	The custom domain name.	api.demo.com
BindStageName	string	No	The environment which you can access by using the domain name. If you do not specify this parameter, the domain name can be used to access all environments. If you specify an environment, the domain name can be used to access only the specified environment. Valid values: TEST PRE RELEASE If you want to use the domain name to access all environments, set this parameter to an empty string ("").	RELEASE
CustomDomainType	string	No	The network type of the domain name to be bound. Default value: INTERNET. Valid values: INTERNET INTRANET. If you set this parameter to this value, the domain name cannot be used on the Internet.	INTERNET
IsForce	boolean	No	Specifies whether this binding relationship takes precedence over the binding relationships between the domain name and other API groups. If you set this parameter to true, this binding relationship takes precedence, and the domain name is automatically unbound from other API groups. This operation brings risks. Proceed with caution.	false
IsHttpRedirectToHttps	boolean	No	Specifies whether to redirect HTTP requests to HTTPS requests.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
DomainLegalStatus	string	The validity status of the domain name. Valid values: NORMAL: The domain name is valid. ABNORMAL: The domain name is invalid. This status affects API calls and must be resolved as soon as possible.	NORMAL
GroupId	string	The ID of the API group. This ID is generated by the system and globally unique.	927d50c0f2e54b359919923d908bb015
SubDomain	string	The second-level domain name assigned to the API group. This domain name is used to test API calls.	xxx-cn-hangzhou.alicloudapi.com
DomainName	string	The custom domain name.	api.demo.com
DomainBindingStatus	string	The binding status of the custom domain name. Valid values: BINDING: The domain name has been bound. BOUND: The domain name has not been bound.	BINDING
DomainRemark	string	The remarks on the domain name, such as the cause of an exception.	无
DomainWebSocketStatus	string	The status of the domain name that uses the WebSocket feature.	NORMAL

Examples

Success response

JSON format

{
  "RequestId": "0AA90E87-3506-5AA6-AFFB-A4D53B4F6231",
  "DomainLegalStatus": "NORMAL",
  "GroupId": "927d50c0f2e54b359919923d908bb015",
  "SubDomain": "xxx-cn-hangzhou.alicloudapi.com",
  "DomainName": "api.demo.com",
  "DomainBindingStatus": "BINDING",
  "DomainRemark": "无",
  "DomainWebSocketStatus": "NORMAL"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.