All Products
Search

This Product

    API Gateway:SetDomain

    Document Center

    API Gateway:SetDomain

    Last Updated:Oct 19, 2024

    Binds a custom domain name to a specified API group.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    GroupIdstringYes

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

    		927d50c0f2e54b359919923d908bb015
    DomainNamestringYes

    The custom domain name.

    		api.demo.com
    BindStageNamestringNo

    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
    CustomDomainTypestringNo

    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
    IsForcebooleanNo

    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
    IsHttpRedirectToHttpsbooleanNo

    Specifies whether to redirect HTTP requests to HTTPS requests.

    		false

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

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

    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
    GroupIdstring

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

    		927d50c0f2e54b359919923d908bb015
    SubDomainstring

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

    		xxx-cn-hangzhou.alicloudapi.com
    DomainNamestring

    The custom domain name.

    		api.demo.com
    DomainBindingStatusstring

    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
    DomainRemarkstring

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

    		None
    DomainWebSocketStatusstring

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

    		NORMAL

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history