All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainCertificateInfo

Last Updated:Nov 07, 2022

Queries the certificate information about a specific domain name for CDN.

Operation Description

NoteThis operation is available only in the China (Shanghai) region.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:DescribeVodDomainCertificateInfoRead
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without
vod:DescribeVodDomainCertificateInfoRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The domain name for CDN.

example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

5C1E43DC-9E51-4771-****-7D5ECEB547A1
CertInfosarray

The certificate information.

object
Statusstring

The status of the certificate.

  • success: indicates that the certificate has taken effect.
  • checking: indicates that the system is checking whether the domain name has been added to ApsaraVideo VOD.
  • cname_error: indicates that the domain name has not been added to ApsaraVideo VOD.
  • domain_invalid: indicates that the domain name contains invalid characters.
  • unsupport_wildcard: indicates that wildcard domain names are not supported.
  • applying: indicates that the certificate is in the application process.
  • failed: indicates that the request of applying for the certificate has failed.
success
CertLifestring

The validity period of the certificate. Unit: month or year.

3 months
CertExpireTimestring

The time when the certificate expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2018-06-03T13:03:39Z
CertTypestring

The type of the certificate. Valid values:

  • free: a free certificate.
  • cas: a certificate that is purchased from Alibaba Cloud SSL Certificates Service.
  • upload: a user-uploaded certificate.
free
ServerCertificateStatusstring

The status of the server certificate.

  • success: indicates that the certificate has taken effect.
  • checking: indicates that the system is checking whether the domain name has been added to ApsaraVideo VOD.
  • cname_error: indicates that the domain name has not been added to ApsaraVideo VOD.
  • domain_invalid: indicates that the domain name contains invalid characters.
  • unsupport_wildcard: indicates that wildcard domain names are not supported.
  • applying: indicates that the certificate is in the application process.
  • failed: indicates that the request of applying for the certificate has failed.
checking
CertDomainNamestring

The domain name that matches the certificate.

example.com
CertNamestring

The name of the certificate.

cert-example.com
CertOrgstring

The certificate authority (CA) that issued the certificate.

Let's Encrypt
DomainNamestring

The domain name for CDN.

example.com

Example

Normal return example

JSONFormat

{
  "RequestId": "5C1E43DC-9E51-4771-****-7D5ECEB547A1",
  "CertInfos": [
    {
      "Status": "success",
      "CertLife": "3 months",
      "CertExpireTime": "2018-06-03T13:03:39Z",
      "CertType": "free",
      "ServerCertificateStatus": "checking",
      "CertDomainName": "example.com",
      "CertName": "cert-example.com",
      "CertOrg": "Let's Encrypt",
      "DomainName": "example.com"
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
InvalidDomain.NotFoundThe domain provided does not belong to you.404The error message returned because the domain name does not exist or does not belong to you.