All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnDomainByCertificate

Last Updated:Mar 01, 2024

Queries accelerated domain names by SSL certificate.

Operation description

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
SSLPubstringYes

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
SSLStatusbooleanNo

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
ExactbooleanNo

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 parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D
CertInfosobject []

The information about the certificate.

CertStartTimestring

The time at which the certificate became effective.

Nov 29 23:59:59 2017 GMT
CertExpireTimestring

The time at which the certificate expires.

Nov 29 00:00:00 2016 GMT
CertCaIsLegacystring

Indicates whether the SSL certificate is obsolete. Valid values:

  • yes: The SSL certificate is obsolete.
  • no: The SSL certificate is working as expected.
yes
CertSubjectCommonNamestring

The name of the SSL certificate owner.

example.aliyundoc.com
CertTypestring

The type of the certificate. RSA, DSA, and ECDSA.

RSA
DomainNamesstring

The domain names (DNS fields) that match the certificate. Multiple domain names are separated with commas (,).

*.example.com,example.org
CertExpiredstring

Indicates whether the SSL certificate is expired. Valid values:

  • yes: The SSL certificate is expired.
  • no: The SSL certificate is not expired.
yes
Issuerstring

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
DomainListstring

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 codeError codeError messageDescription
400Certificate.FormatErrorThe format of the certificate is invalid.The specified certificate format is invalid.
400SSLPub.MissingParameterThe SSLPub parameter is required.The SSLPub parameter is not specified.
400Decode.ErrorError decoding the SSLPub or SSLPri certificate.The system has failed to decode the public key or the private key of the SSL certificate.
500InternalErrorAn 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 timeSummary of changesOperation
2023-08-22The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Exact