DescribeDomain - API Gateway - Alibaba Cloud Documentation Center

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

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
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 parameters

Parameter	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 name does not have an ICP filing.
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	long	证书生效时间戳（毫秒）	1672502400000
CertificateValidEnd	long	证书失效时间戳（毫秒）	1704038400000

Examples

Sample success responses

JSONformat

{
  "CertificatePrivateKey": "xxx",
  "DomainName": "api.demo.com",
  "DomainBindingStatus": "BINDING",
  "DomainRemark": "The domain name does not have an ICP filing.\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 time	Summary of changes	Operation
2023-03-21	API Description Update. The response structure of the API has changed	View Change Details