DocsICP FilingConsole
Documentation

DescribeVodDomainCertificateInfo

Updated at:
Copy as MD
Product
My Favorites

Retrieves the certificate information of a specified accelerated domain name.

Operation description

Currently, the only supported region is China (Shanghai).

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

vod:DescribeVodDomainCertificateInfo

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
DomainName

string

Yes

The accelerated domain name for ApsaraVideo VOD.

example.com
HeraApiAutoVersion

string

No

Response elements

Element

Type

Description

Example

object

The returned results.

RequestId

string

The request ID.

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

object

CertInfo

array<object>

The certificate information.

object

CertExpireTime

string

The expiration time of the certificate. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

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

string

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

3 months
Status

string

The certificate status. Valid values:

  • success: The certificate has taken effect.

  • checking: Checking whether the domain name is added to ApsaraVideo VOD.

  • cname_error: The domain name is not mapped to the CNAME assigned by ApsaraVideo VOD.

  • domain_invalid: The domain name contains invalid characters.

  • unsupport_wildcard: Wildcard domain names are not supported.

  • applying: The certificate application is in progress.

  • failed: The certificate application failed.

Note

This field returns a value only when CertType is set to free. For other certificate types, this field is empty.

success
CertUpdateTime

string

The time when the certificate was updated. The time follows the ISO 8601 standard and is displayed in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

2023-04-26T20:23:38Z
CertDomainName

string

The domain name matched by the certificate.

example.com
ServerCertificateStatus

string

The enabling status of the HTTPS certificate. Valid values:

  • on: Enabled.

  • off: Disabled.

on
CertOrg

string

The certificate organization.

Let's Encrypt
DomainName

string

The accelerated domain name.

example.com
CertStartTime

string

The start time of the certificate. The time follows the ISO 8601 standard and is displayed in the yyyy-MM-ddTHH:mm:ssZ format (UTC).

2023-04-26T20:23:38Z
CertType

string

The certificate type. Valid values:

  • free: Free certificate.

  • cas: SSL Certificates Service certificate.

  • upload: Custom upload.

free
CertName

string

The certificate name.

cert-example.com
DomainCnameStatus

string

The CNAME status of the domain name. Valid values:

  • ok: The domain name is mapped to the CNAME allocated by Content Delivery Network (CDN).

  • cname_error: A fault occurred. The domain name cannot be mapped to the CNAME.

  • op_domain_cname_error: A fault occurred with the CNAME of the top-level domain. The domain name cannot be mapped to the CNAME.

  • unsupport_wildcard: Wildcard domain names are not supported.

ok
ServerCertificate

string

The certificate public key.

****
CertId

string

The certificate ID.

13227737-cn-hangzhou
CertRegion

string

The region where the certificate is used.

cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "5C1E43DC-9E51-4771-****-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "CertExpireTime": "2018-06-03T13:03:39Z",
        "CertLife": "3 months",
        "Status": "success",
        "CertUpdateTime": "2023-04-26T20:23:38Z",
        "CertDomainName": "example.com",
        "ServerCertificateStatus": "on",
        "CertOrg": "Let's Encrypt",
        "DomainName": "example.com",
        "CertStartTime": "2023-04-26T20:23:38Z",
        "CertType": "free",
        "CertName": "cert-example.com",
        "DomainCnameStatus": "ok",
        "ServerCertificate": "****",
        "CertId": "13227737-cn-hangzhou",
        "CertRegion": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.