All Products
Search
Document Center

Certificate Management Service:GetCAInstanceStatus

Last Updated:Dec 07, 2023

Queries the status information about a private root certificate authority (CA) instance or a private intermediate CA instance that you purchase by using the Certificate Management Service console.

Operation Description

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.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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
yundun-cert:GetCAInstanceStatusRead
  • All Resources
    acs:yundun-cert:*:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringNo

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.
cas-member-0hmi****
IdentifierstringNo

The unique identifier of the certificate.

160ae6bb538d538c70c01f81dcf2****

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

25589516-2A56-5159-AB88-4A1D9824E183
InstanceStatusListobject []

The status information of the private CA instance.

CertTotalCountinteger

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

10
Statusstring

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.
USED
Typestring

The type of the private CA instance. Valid values:

  • ROOT: root CA instance
  • SUB_ROOT: intermediate CA instance
ROOT
CertIssuedCountinteger

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

1
BeforeTimelong

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.
1635177600000
Identifierstring

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.
a7bb2dd212a2112128cd5cc9b753****
AfterTimelong

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.
1792944000000
InstanceIdstring

The ID of the private CA instance.

cas-member-0hmi****
UseExpireTimelong

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.
1637251200000

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-05The input parameters of the API operation change.see changesets
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: Identifier