All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodDomainCertificateInfo

Last Updated:May 22, 2024

Queries the certificate information about an accelerated domain name.

Operation description

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

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
vod:DescribeVodDomainCertificateInfoRead
  • All Resources
    *
    none
none
vod:DescribeVodDomainCertificateInfoRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name.

example.com

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The ID of the request.

5C1E43DC-9E51-4771-****-7D5ECEB547A1
CertInfosobject []

The certificate information about the domain name.

Statusstring

The status of the certificate.

  • success: The certificate is in effect.
  • checking: The system is checking whether the domain name is added to ApsaraVideo VOD.
  • cname_error: The domain name is not added to ApsaraVideo VOD.
  • domain_invalid: The domain name contains invalid characters.
  • unsupport_wildcard: The domain name is a wildcard domain name. Wildcard domain names are not supported.
  • applying: The certificate application is in progress.
  • failed: The certificate application failed.
Note A value is returned for this parameter only when you set CertType to free. Otherwise, an empty value is returned for this parameter.
success
CertLifestring

The validity period of the certificate. Unit: months or years.

3 months
CertExpireTimestring

The time at which the certificate expires. The time is 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 Certificate Management Service.
  • upload: a user-uploaded certificate.
free
ServerCertificateStatusstring

The status of the SSL certificate.

  • on
  • off
checking
CertDomainNamestring

The domain name that matches the certificate.

example.com
CertNamestring

The certificate name.

cert-example.com
CertOrgstring

The certificate authority (CA) that issued the certificate.

Let's Encrypt
DomainNamestring

The accelerated domain name whose ICP filing status you want to update.

example.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "5C1E43DC-9E51-4771-****-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "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 Service error codes.