Queries the status information of a private root certificate authority (CA) instance or a private intermediate CA instance that you purchase by using the SSL Certificates Service console.

Usage notes

You can call the GetCAInstanceStatus operation to query the status information of a private CA instance by using the ID of the instance. The instance is purchased by using the SSL Certificates Service console. The status information includes the status of the private CA instance, the number of certificates that can be issued by using the private CA instance, and the number of issued certificates.

Before you call this operation, make sure that you have purchased a private CA by using the SSL Certificates Service console. For more information, see Create a private CA.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetCAInstanceStatus

The operation that you want to perform. Set the value to GetCAInstanceStatus.

InstanceId String Yes cas-member-0hmi****

The ID of the private CA instance.

Note After you purchase a private CA instance by using the SSL Certificates Service console, you can click Details for the private CA instance on the Private Certificates page to query the ID of the private CA instance.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String 25589516-2A56-5159-AB88-4A1D9824E183

The ID of the request.

InstanceStatusList Array of InstanceStatus

The status information of the private CA instance.

CertTotalCount Integer 10

The number of certificates that can be issued by using the private CA instance.

For a private root CA instance whose Type is ROOT, this parameter indicates the number of intermediate CA certificates that can be issued.

For a private intermediate CA instance whose Type is SUB_ROOT, this parameter indicates the total number of client certificates and server certificates that can be issued

Status String USED

The status of the private CA instance. Valid values:

  • BUY: The private CA instance is purchased but is not enabled.
  • USED: The private CA instance is enabled.
  • REFUND: The private CA instance is refunded.
  • REVOKE: The private CA instance is revoked.
Type String ROOT

The type of the private CA instance. Valid values:

  • ROOT: root CA instance
  • SUB_ROOT: intermediate CA instance
CertIssuedCount Integer 1

The number of certificates that are issued by using the private CA instance.

BeforeTime Long 1635177600000

The issuance date of the private CA certificate. This value is a UNIX timestamp. Unit: milliseconds.

Note This parameter is returned only when the value of the Status parameter is USED or REVOKE. The value USED indicates that the private CA instance is enabled, and the value REVOKE indicates that the instance is revoked.
Identifier String a7bb2dd212a2112128cd5cc9b753****

The unique identifier of the private CA certificate.

Note This parameter is returned only when the value of the Status parameter is USED or REVOKE. The value USED indicates that the private CA instance is enabled, and the value REVOKE indicates that the instance is revoked.
AfterTime Long 1792944000000

The expiration date of the private CA certificate. This value is a UNIX timestamp. Unit: milliseconds.

Note This parameter is returned only when the value of the Status parameter is USED or REVOKE. The value USED indicates that the private CA instance is enabled, and the value REVOKE indicates that the instance is revoked.
InstanceId String cas-member-0hmi****

The ID of the private CA instance.

UseExpireTime Long 1637251200000

The expiration date of the private CA instance. This value is a UNIX timestamp. Unit: milliseconds.

Note This parameter corresponds to the duration that you select when you purchase the private CA instance. The duration indicates the subscription period of the Private Certificate Authority (PCA) service.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetCAInstanceStatus
&InstanceId=cas-member-0hmi****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetCAInstanceStatusResponse>
    <RequestId>25589516-2A56-5159-AB88-4A1D9824E183</RequestId>
    <InstanceStatusList>
        <Status>USED</Status>
        <Type>ROOT</Type>
        <Identifier>a7bb2dd212a2112128cd5cc9b753****</Identifier>
        <InstanceId>cas-member-0hmi****</InstanceId>
        <BeforeTime>1635177600000</BeforeTime>
        <UseExpireTime>1637251200000</UseExpireTime>
        <AfterTime>1792944000000</AfterTime>
        <CertTotalCount>10</CertTotalCount>
        <CertIssuedCount>1</CertIssuedCount>
    </InstanceStatusList>
    <InstanceStatusList>
        <Status>USED</Status>
        <Type>SUB_ROOT</Type>
        <Identifier>93b09902767679da31f23adc9513****</Identifier>
        <InstanceId>cas-member-0hmi****</InstanceId>
        <BeforeTime>1635177600000</BeforeTime>
        <UseExpireTime>1637251200000</UseExpireTime>
        <AfterTime>1792944000000</AfterTime>
        <CertTotalCount>10</CertTotalCount>
        <CertIssuedCount>1</CertIssuedCount>
    </InstanceStatusList>
</GetCAInstanceStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "25589516-2A56-5159-AB88-4A1D9824E183",
  "InstanceStatusList" : [ {
    "Status" : "USED",
    "Type" : "ROOT",
    "Identifier" : "a7bb2dd212a2112128cd5cc9b753****",
    "InstanceId" : "cas-member-0hmi****",
    "BeforeTime" : 1635177600000,
    "UseExpireTime" : 1637251200000,
    "AfterTime" : 1792944000000,
    "CertTotalCount" : 10,
    "CertIssuedCount" : 1
  }, {
    "Status" : "USED",
    "Type" : "SUB_ROOT",
    "Identifier" : "93b09902767679da31f23adc9513****",
    "InstanceId" : "cas-member-0hmi****",
    "BeforeTime" : 1635177600000,
    "UseExpireTime" : 1637251200000,
    "AfterTime" : 1792944000000,
    "CertTotalCount" : 10,
    "CertIssuedCount" : 1
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.