Use DescribeCdnDomainByCertificate to query accelerated domain names by SSL certificate - CDN - Alibaba Cloud - CDN

Queries accelerated domain names by SSL certificate.

Operation description

Note

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

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

cdn:DescribeCdnDomainByCertificate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SSLPub	string	Yes	The public key of the SSL certificate. You must encode the public key in Base64 and then call the encodeURIComponent function to encode the public key again. The public key must be in the PEM format.	******
SSLStatus	boolean	No	Specifies whether the domain name list to return contains only domain names with HTTPS enabled or disabled. true: The domain name list contains only domain names with HTTPS enabled. false: The domain name list contains only domain names with HTTPS disabled.	true
Exact	boolean	No	Specifies whether the domain name list to return match the SSL certificate. true: The domain name list match the SSL certificate. false: The domain name list do not match the SSL certificate.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D
CertInfos	object
CertInfo	array<object>	The information about the certificate.
	object
CertStartTime	string	The time when the certificate became effective.	Nov 29 23:59:59 2017 GMT
CertExpireTime	string	The expiration time of the certificate.	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.	owner
CertType	string	The type of the certificate. Valid values: RSA, DSA, and ECDSA.	RSA
DomainNames	string	The domain names (DNS fields) that match the SSL certificate. Multiple domain names are separated by commas (,).	*.example.com,aliyundoc.com
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	If a value is returned, the value matches the SSL certificate. Multiple domain names are separated by commas (,).	example.com,aliyundoc.com

Examples

Success response

JSON format

{
  "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": "owner",
        "CertType": "RSA",
        "DomainNames": "*.example.com,aliyundoc.com",
        "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,aliyundoc.com"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Certificate.FormatError	The format of the certificate is invalid.	The specified certificate is invalid.
400	SSLPub.MissingParameter	The Cert parameter is required.
400	Decode.Error	Error decoding the SSLPub certificate.
400	Certificate.DecodeError	An error occurred while decoding the certificate.
500	InternalError	The request processing has failed due to backend service exception.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.