DescribeDcdnDomainByCertificate - Edge Security Acceleration

Call the DescribeDcdnDomainByCertificate operation to query domain names based on certificate information.

Operation description

Note

A single user 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

dcdn:DescribeDcdnDomainByCertificate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SSLPub	string	Yes	The public key of the certificate. The public key must be in PEM format. The value must be Base64-encoded and then encoded using `encodeURIComponent`. The value must first be Base64-encoded and then `encodeURIComponent`-encoded. The PEM format is supported.	xxx
SSLStatus	boolean	No	Specifies whether to return only domain names for which HTTPS is enabled or disabled. true: enabled false: disabled	true
Exact	boolean	No	Specifies whether the returned domain names must be an exact match for the certificate. true: enabled false: disabled	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ASAF2FDS-12SADSA-DDSAE3D-DSADCD4C-CDADS2D
CertInfos	object
CertInfo	array<object>	The certificate information.
	object
CertStartTime	string	The start time of the certificate's validity period.	Nov 29 23:59:59 2017 GMT
CertExpireTime	string	The expiration time of the certificate.	Nov 29 00:00:00 2016 GMT
CertCaIsLegacy	string	The deprecation status of the certificate authority (CA). Valid values: yes: The CA is deprecated. no: The CA is not deprecated.	yes
CertSubjectCommonName	string	The common name of the certificate owner.	example.aliyundoc.com
CertType	string	The type of the certificate. Valid values are RSA, DSA, and ECDSA.	RSA
DomainNames	string	The domain names that match the certificate, as specified in the DNS field. If there are multiple domain names, separate them with commas (,).	*.example.com,example.org
CertExpired	string	The expiration status of the certificate. Valid values: yes: The certificate has expired. no: The certificate has not expired.	yes
Issuer	string	The certificate issuer.	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. Multiple domain names are separated by commas (,). 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

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": "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.