SetDomain
Region:
China (Beijing)
Request Parameters
Required
GroupIdThe ID of the API g...
DomainNameThe custom domain name
BindStageNameThe environment whi...
CustomDomainTypeThe network type of...
IsForceSpecifies whether t...
Please select a Boolean value
IsHttpRedirectToHttpsSpecifies whether t...
Please select a Boolean value
Plugin DownloadLearn more
VS Code Plugin
Before installing the plugin, please install VS CodeBefore installing the plugin, please install VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains Plugin
Before installing the plugin, please install JetBrains IDEBefore installing the plugin, please install JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

Request Parameters

Field NameField Details
GroupIdstring

The ID of the API group. This ID is generated by the system and globally unique.

Example:927d50c0f2e54b359919923d908bb015Reference Value Source:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
DomainNamestring

The custom domain name.

Example:api.demo.com
BindStageNamestring

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.View Details...

Example:RELEASE
CustomDomainTypestring

The network type of the domain name to be bound. Default value: INTERNET. Valid values:View Details...

Example:INTERNET
IsForceboolean

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.

Example:false
IsHttpRedirectToHttpsboolean

Specifies whether to redirect HTTP requests to HTTPS requests.

Example:false

Response Parameters

Field NameField Details
RequestIdstring

The ID of the request.

Example:0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
DomainLegalStatusstring

The validity status of the domain name. Valid values:View Details...

Example:NORMAL
GroupIdstring

The ID of the API group. This ID is generated by the system and globally unique.

Example:927d50c0f2e54b359919923d908bb015
SubDomainstring

The second-level domain name assigned to the API group. This domain name is used to test API calls.

Example:xxx-cn-hangzhou.alicloudapi.com
DomainNamestring

The custom domain name.

Example:api.demo.com
DomainBindingStatusstring

The binding status of the custom domain name. Valid values:View Details...

Example:BINDING
DomainRemarkstring

The remarks on the domain name, such as the cause of an exception.

Example:None
DomainWebSocketStatusstring

The status of the domain name that uses the WebSocket feature.

Example:NORMAL
Change History
No Change History found.