All Products
Search

This Product

    API Gateway:DescribeDomain

    Document Center

    API Gateway:DescribeDomain

    Last Updated:Mar 30, 2026

    Queries details about a bound custom domain name, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.

    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:DescribeDomain

    get

    *ApiGroup

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

    		 None 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

    Response elements

    Element

    Type

    Description

    Example

    object

    CertificatePrivateKey

    string

    The private key of the SSL certificate.

    xxx
    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

    Remarks about the domain name, such as the cause of an exception.

    The domain is not registered with the MIIT.
    CertificateId

    string

    The unique ID of the SSL certificate, which is automatically generated by the system.

    6EF60BEC-0242-43AF-BB20-270359FB54A7
    DomainWebSocketStatus

    string

    The status of the domain name that uses WebSocket.

    NORMAL
    RequestId

    string

    The ID of the request.

    6EF60BEC-0242-43AF-BB20-270359FB54A7
    CertificateName

    string

    The name of the SSL certificate.

    myCertificate
    DomainLegalStatus

    string

    The validity status of the domain name. Valid values:

    • NORMAL

    • ABNORMAL: 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
    CertificateBody

    string

    The content of the certificate.

    xxx
    SubDomain

    string

    The second-level domain name that is automatically assigned to the API group.

    xxx-cn-hangzhou.alicloudapi.com
    DomainCNAMEStatus

    string

    The domain name resolution status. Valid values:

    • RESOLVED: The domain name has been resolved.

    • UNRESOLVED: The domain name has not been resolved.

    RESOLVED
    CertificateValidStart

    integer

    Certificate effective timestamp(milliseconds)

    1672502400000
    CertificateValidEnd

    integer

    Certificate expiration timestamp(milliseconds)

    1704038400000

    Examples

    Success response

    JSON format

    {
  "CertificatePrivateKey": "xxx",
  "DomainName": "api.demo.com",
  "DomainBindingStatus": "BINDING",
  "DomainRemark": "The domain is not registered with the MIIT.",
  "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
  "DomainWebSocketStatus": "NORMAL",
  "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
  "CertificateName": "myCertificate",
  "DomainLegalStatus": "NORMAL",
  "GroupId": "927d50c0f2e54b359919923d908bb015",
  "CertificateBody": "xxx",
  "SubDomain": "xxx-cn-hangzhou.alicloudapi.com",
  "DomainCNAMEStatus": "RESOLVED",
  "CertificateValidStart": 1672502400000,
  "CertificateValidEnd": 1704038400000
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.