DescribeDcdnDomainByCertificate - Edge Security Acceleration

Queries accelerated domain names by SSL certificate.

Operation description

Note You can call this operation up to 100 times per second per account.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SSLPub	string	Yes	The public key of the certificate. You must use Base64 encoding schemes and then the encodeURIComponent method to encode the public key. PEM files are supported.	xxx
SSLStatus	boolean	No	Specifies whether the domain name list to return contains only domain names with HTTPS enabled or disabled. true: The list contains only domain names with HTTPS enabled. false: The list contains only domain names with HTTPS disabled.	true
Exact	boolean	No	Specifies whether the domain name list to return matches the SSL certificate. true: The domain name list matches the SSL certificate. false: The domain name list does not match the SSL certificate.	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D
CertInfos	array<object>	The information about the certificate.
CertInfo	object
CertStartTime	string	The time at which the certificate became effective.	Nov 29 23:59:59 2017 GMT
CertExpireTime	string	The time at which the certificate expires.	Nov 29 00:00:00 2016 GMT
CertCaIsLegacy	string	Indicates whether the SSL certificate is obsolete. Valid values: yes: The SSL certificate is obsolete. no: The SSL certificate is working as expected.	yes
CertSubjectCommonName	string	The name of the SSL certificate owner.	example.aliyundoc.com
CertType	string	The type of the certificate. Valid values: RSA, DSA, and ECDSA.	RSA
DomainNames	string	The domain names (DNS fields) that match the certificate. Multiple domain names are separated with commas (,).	*.example.com,example.org
CertExpired	string	Indicates whether the SSL certificate is expired. Valid values: yes: The SSL certificate is expired. no: The SSL certificate is not expired.	yes
Issuer	string	The certificate authority (CA) that issued the certificate.	C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1
DomainList	string	The list of domain names that use the certificate. If one or more domain names are returned, the domain names are matched with the specified certificate. Multiple domain names are separated with commas (,).	example.com,example.org

Examples

Sample success responses

JSONformat

{
  "RequestId": "ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D",
  "CertInfos": {
    "CertInfo": [
      {
        "CertStartTime": "Nov 29 23:59:59 2017 GMT",
        "CertExpireTime": "Nov 29 00:00:00 2016 GMT",
        "CertCaIsLegacy": "yes",
        "CertSubjectCommonName": "example.aliyundoc.com",
        "CertType": "RSA",
        "DomainNames": "*.example.com,example.org",
        "CertExpired": "yes",
        "Issuer": "C=US, O=Symantec Corporation, OU=Symantec Trust Network, OU=Domain Validated SSL, CN=Symantec Basic DV SSL CA - G1",
        "DomainList": "example.com,example.org"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Certificate.FormatError	The format of the certificate is invalid.	The specified certificate format is invalid.
400	SSLPub.MissingParameter	The SSLPub parameter is required.	The SSLPub parameter is not specified.
400	Decode.Error	Error decoding the SSLPub or SSLPri certificate.	The system has failed to decode the public key or the private key of the SSL certificate.
500	InternalError	An internal error occurred; please try again later.	An internal error occurred. Try again later. If the error persists, submit a ticket.

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

Change history

Change time	Summary of changes	Operation
2023-08-22	The Error code has changed. The request parameters of the API has changed	View Change Details