GetCAInstanceStatus - Certificate Management Service - Alibaba Cloud Documentation Center

Queries the status of a private root or intermediate CA instance that you purchased in the Certificate Management Service console.

Operation description

Use this operation to query the status of a private CA instance by its ID. The status information includes the instance's status, the total number of certificates it can issue, and the number of certificates already issued.

Before you call this operation, purchase a private CA in the Certificate Management Service console. For more information, see Purchase a private CA.

QPS limits

This operation has a queries per second (QPS) limit of 10 for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this operation at a reasonable rate.

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:GetCAInstanceStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the private CA instance to query. Note After you purchase a private CA instance in the Certificate Management Service console, you can go to the Private Certificates page and view the details of the instance to obtain its ID.	cas-member-0hmi****
Identifier	string	No	The unique identifier of the client certificate or server-side certificate to query. Note Call ListClientCertificate to query the unique identifiers of all client certificates and server-side certificates.	160ae6bb538d538c70c01f81dcf2****

Response elements

Element	Type	Description	Example
	object	The object.
RequestId	string	The ID of the request.	25589516-2A56-5159-AB88-4A1D9824E183
InstanceStatusList	array<object>	The status details of the private CA instance.
	object	The object.
CertTotalCount	integer	The number of certificates that the private CA instance can issue. If the private CA is a root CA (Type is ROOT), this parameter indicates the number of intermediate CA certificates that can be issued. If the private CA is an intermediate CA (Type is SUB_ROOT), this parameter indicates the total number of client certificates and server-side certificates that can be issued.	10
Status	string	The status of the private CA instance. Valid values: BUY: The instance is purchased but not enabled. USED: The instance is enabled. REFUND: A refund has been issued for the instance. REVOKE: The instance is revoked.	USED
Type	string	The type of the private CA instance. Valid values: ROOT: Root CA instance. SUB_ROOT: Intermediate CA instance.	ROOT
CertIssuedCount	integer	The number of certificates that the private CA instance has issued.	1
BeforeTime	integer	The issuance date of the private CA certificate. This value is a UNIX timestamp. Unit: milliseconds. Note This parameter is returned only if Status is USED (the private CA instance is enabled) or REVOKE (the private CA instance is revoked).	1635177600000
Identifier	string	The unique identifier of the private CA certificate. Note This parameter is returned only if Status is USED (the private CA instance is enabled) or REVOKE (the private CA instance is revoked).	a7bb2dd212a2112128cd5cc9b753****
AfterTime	integer	The expiration date of the private CA certificate. This value is a UNIX timestamp. Unit: milliseconds. Note This parameter is returned only if Status is USED (the private CA instance is enabled) or REVOKE (the private CA instance is revoked).	1792944000000
InstanceId	string	The ID of the private CA instance.	cas-member-0hmi****
UseExpireTime	integer	The expiration date of the private CA instance. This value is a UNIX timestamp. Unit: milliseconds. Note This parameter corresponds to the subscription duration that you selected for the Private Certificate Authority (PCA) service when you purchased the instance.	1637251200000

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.