All Products
Search

This Product

    API Gateway:SetDomain

    Document Center

    API Gateway:SetDomain

    Last Updated:Sep 25, 2024

    Binds a custom domain name to a specified API group.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    apigateway:SetDomainupdate
    • ApiGroup
      acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}
      none
    		none

    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