All Products
Search
Document Center

API Gateway:DescribeDomain

Last Updated:Mar 01, 2024

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

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:DescribeDomainRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringYes

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

927d50c0f2e54b359919923d908bb015
DomainNamestringYes

The custom domain name.

api.demo.com

Response parameters

ParameterTypeDescriptionExample
object
CertificatePrivateKeystring

The private key of the SSL certificate.

xxx
DomainNamestring

The custom domain name.

api.demo.com
DomainBindingStatusstring

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

  • BINDING: The domain name is bound to the API group.
  • BOUND: The domain name is not bound to the API group.
BINDING
DomainRemarkstring

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

The status of the domain name that uses WebSocket.
CertificateIdstring

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

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

The status of the domain name that uses WebSocket.

NORMAL
RequestIdstring

The request ID.

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

The SSL certificate name.

myCertificate
DomainLegalStatusstring

The validity status of the domain name. Valid values:

  • NORMAL
  • ABNORMAL: This status affects API calls and must be rectified as soon as possible.
NORMAL
GroupIdstring

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

927d50c0f2e54b359919923d908bb015
CertificateBodystring

The certificate content.

xxx
SubDomainstring

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

xxx-cn-hangzhou.alicloudapi.com
DomainCNAMEStatusstring

The domain name resolution status. Valid values:

  • RESOLVED: The domain name has been resolved.
  • UNRESOLVED: The domain name has not been resolved.
RESOLVED
CertificateValidStartlong

The time when the certificate takes effect. The value is a timestamp. Unit: milliseconds.

1672502400000
CertificateValidEndlong

The time when the certificate expires. The value is a timestamp. Unit: milliseconds.

1704038400000

Examples

Sample success responses

JSONformat

{
  "CertificatePrivateKey": "xxx",
  "DomainName": "api.demo.com",
  "DomainBindingStatus": "BINDING",
  "DomainRemark": "The status of the domain name that uses WebSocket.\n",
  "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

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

Change history

Change timeSummary of changesOperation
2023-03-21API Description Update. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Output ParametersThe response structure of the API has changed.