All Products
Search

This Product

    Certificate Management Service:GetInstanceDetail

    Document Center

    Certificate Management Service:GetInstanceDetail

    Last Updated:Jun 26, 2026

    Queries the details of an instance.

    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

    yundun-cert:GetInstanceDetail

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the instance.

    cas_dv-cn-123

    Response elements

    Element

    Type

    Description

    Example

    object

    InstanceId

    string

    The ID of the instance.

    cas_dv-cn-123
    InstanceType

    string

    The instance type. Valid values:

    • BUY: formal certificate.

    • TEST: test certificate.

    TEST
    RequestId

    string

    The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.

    B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9
    KeyAlgorithm

    string

    The certificate algorithm. Valid values:

    • RSA_2048

    • RSA_3072

    • RSA_4096

    • ECC_256

    • SM2.

    RSA_2048
    Status

    string

    The instance status. Valid values:

    • inactive: pending use.

    • pending: under review. The latest certificate is being reviewed.

    • willExpire: the instance is about to expire.

    • expired: the instance has expired.

    • refund: refunded.

    • normal: normal.

    • closed: closed and unavailable.

    inactive
    Domain

    string

    The domain name bound to the certificate.

    example.com
    CertificateId

    integer

    The certificate ID.

    1234567890
    CertificateName

    string

    The name of the instance. When a certificate is issued, this name is used as the default certificate name.

    123
    CertIdentifier

    string

    The global certificate ID, in the format of certificate ID + "-" + site region ID. This ID is commonly used across Alibaba Cloud services. --For the China site, the format is certificate ID + "-cn-hangzhou". For the China site, the format is certificate ID + "-ap-southeast-1". For example, if the certificate ID is 123, the CertIdentifier on the China site is "123-cn-hangzhou", and the CertIdentifier on the China site is "123-ap-southeast-1".

    22783111-cn-hangzhou
    Spec

    string

    The purchased instance specification.

    ss.dv.t
    CertificateType

    string

    The type of the certificate. Valid values: DV, OV, and EV.

    DV
    CertificateStatus

    string

    The status of the certificate. Valid values:

    • issued: issued.

    • revoked: revoked.

    • willExpire: about to expire.

    • expired: expired.

    issued
    CertificateNotAfter

    integer

    The end time of the latest certificate. The value is a UNIX timestamp. This field is empty if no certificate has been issued.

    1801324800000
    CertificateNotBefore

    integer

    OrderEndTime

    integer

    The end time of the instance purchase. The value is a UNIX timestamp. You can use this value to determine the purchase duration of the instance.

    1801324800000
    InstanceStartTime

    integer

    The start time of the instance. The value is a UNIX timestamp. If no certificate has been issued, this field is empty.

    1801324800000
    InstanceEndTime

    integer

    The expiration time of the instance. The value is a UNIX timestamp. If no certificate has been issued, this field is empty.

    1801324800000
    FullDomainCount

    integer

    The number of exact-match domain names.

    1
    WildcardDomainCount

    integer

    The number of wildcard domain names.

    0
    CompanyId

    integer

    The company information ID.

    47305
    ContactIdList

    array

    The list of contact IDs.

    integer

    The contact ID.

    123
    ResourceGroupId

    string

    The resource group ID.

    rg-aek****wia
    DomainValidationList

    array<object>

    The list of domain names to be validated.

    object

    The domain name to be validated.

    Domain

    string

    The domain name to be validated.

    example.com
    RootDomain

    string

    The root domain name.

    example.com
    ValidationType

    string

    The validation type. Valid values: TXT, HTTP, and CNAME.

    TXT
    ValidationValue

    string

    The host record value for validation.

    123
    ValidationKey

    string

    The host record.

    @
    Cname

    string

    The CNAME record value for verification-free authorization. This field may be empty.

    123.com
    CnameKey

    string

    The prefix for CNAME validation.

    abc
    City

    string

    The city where the company or organization of the certificate purchaser is located. This field is required when generating a certificate signing request. Default value: Beijing.

    Beijing
    Province

    string

    The province or region where the company is located. This field is required when generating a certificate signing request. Default value: Beijing.

    Beijing
    CountryCode

    string

    The code of the country or region where the certificate organization is located. For example, CN indicates China, and US indicates the United States. This field is required when generating a certificate signing request. Default value: CN.

    CN
    Csr

    string

    The certificate signing request in PEM format.

    -----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
    ValidationMethod

    string

    The validation method for the certificate application. Valid values:

    • DNS: DNS validation, using TXT or CNAME.

    • HTTP: file-based validation.

    DNS
    AverageWaitingTime

    string

    The average waiting time for issuing a certificate of this specification. Unit: seconds.

    120
    DingGroupList

    array<object>

    The list of associated expert service DingTalk groups.

    object

    The associated expert service DingTalk group.

    DingGroupInstanceId

    string

    The instance ID of the expert service DingTalk group.

    123
    DingGroupName

    string

    The name of the expert service DingTalk group.

    123
    DingGroupType

    string

    The type of the expert service DingTalk group. Valid values:

    • expedite: application assistance.

    • remote: offline deployment.

    remote
    DingGroupUrl

    string

    The link to join the expert service DingTalk group.

    https://123.com
    Tags

    array<object>

    The list of tags.

    object

    The list of tags.

    TagKey

    string

    The tag key.

    test
    TagValue

    string

    The tag value.

    test
    GenerateCsrMethod

    string

    The CSR generation method. Valid values:

    • online: system-generated. The Csr field is ignored.

    • upload: user-uploaded. The Csr field is required.

    online
    AutoReissue

    string

    Specifies whether automatic managed renewal is enabled. Valid values:

    • enable: Enabled.

    • disable: Disabled.

    enable
    PendingResult

    string

    The result returned by the certification authority (CA) during the last certificate operation.

    pending
    UpgradeStatus

    string

    The upgrade status of the instance. Valid values:

    • none: the instance has not been upgraded.

    • payed: the instance upgrade has been paid.

    • issued: the latest certificate has been issued after the instance upgrade.

    none
    CertificateRevokeTime

    integer

    The revocation time of the latest certificate. The value is a UNIX timestamp.

    1801324800000
    Brand

    string

    The CA brand. Valid values: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus, and Alibaba.

    DigiCert
    OrderStartTime

    integer

    The start time of the instance purchase. The value is a UNIX timestamp. You can use this value to determine the refund time limit.

    1801324800000

    Examples

    Success response

    JSON format

    {
  "InstanceId": "cas_dv-cn-123",
  "InstanceType": "TEST",
  "RequestId": "B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9",
  "KeyAlgorithm": "RSA_2048",
  "Status": "inactive",
  "Domain": "example.com",
  "CertificateId": 1234567890,
  "CertificateName": "123",
  "CertIdentifier": "22783111-cn-hangzhou",
  "Spec": "ss.dv.t",
  "CertificateType": "DV",
  "CertificateStatus": "issued",
  "CertificateNotAfter": 1801324800000,
  "CertificateNotBefore": 0,
  "OrderEndTime": 1801324800000,
  "InstanceStartTime": 1801324800000,
  "InstanceEndTime": 1801324800000,
  "FullDomainCount": 1,
  "WildcardDomainCount": 0,
  "CompanyId": 47305,
  "ContactIdList": [
    123
  ],
  "ResourceGroupId": "rg-aek****wia",
  "DomainValidationList": [
    {
      "Domain": "example.com",
      "RootDomain": "example.com",
      "ValidationType": "TXT",
      "ValidationValue": "123",
      "ValidationKey": "@",
      "Cname": "123.com",
      "CnameKey": "abc"
    }
  ],
  "City": "Beijing",
  "Province": "Beijing",
  "CountryCode": "CN",
  "Csr": "-----BEGIN CERTIFICATE REQUEST-----   ...... -----END CERTIFICATE REQUEST-----",
  "ValidationMethod": "DNS",
  "AverageWaitingTime": "120",
  "DingGroupList": [
    {
      "DingGroupInstanceId": "123",
      "DingGroupName": "123",
      "DingGroupType": "remote",
      "DingGroupUrl": "https://123.com"
    }
  ],
  "Tags": [
    {
      "TagKey": "test",
      "TagValue": "test"
    }
  ],
  "GenerateCsrMethod": "online",
  "AutoReissue": "enable",
  "PendingResult": "pending",
  "UpgradeStatus": "none",
  "CertificateRevokeTime": 1801324800000,
  "Brand": "DigiCert",
  "OrderStartTime": 1801324800000
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.