GetCAInstanceStatus
Queries the status information of private root CA instances or private subordinate CA instances purchased through the SSL Certificate Service console.
Operation description
This operation queries the status information of a private CA instance purchased through the SSL Certificate Service console by using the ID of the private CA instance. The status information includes the status of the CA instance, the total number of certificates, and the number of issued certificates.
Before you invoke this operation, you must purchase a private CA through the Digital Certificate Management Service console. For more information, see Purchase a private CA.
QPS limits
The QPS limit for a single user is 10 invocations per second. If the limit is exceeded, API invocations are throttled, which may affect your services. Invoke this operation as needed.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-cert:GetCAInstanceStatus |
get |
*All Resource
|
None | 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 Digital Certificate Management Service console, you can obtain the ID of the private CA instance by viewing the details of the private CA instance on the Private Certificates page. Note: You must specify at least one of the InstanceId and Identifier parameters. If neither is specified, the API returns the 400 MissingParameter.instanceId/identifier error. |
cas-member-0hmi**** |
| Identifier |
string |
No |
The unique identifier of the client certificate or server certificate to query. Note
You can call the ListClientCertificate operation to query the unique identifiers of all client certificates and server certificates. Note: You must specify at least one of the InstanceId and Identifier parameters. If neither is specified, the API returns the 400 MissingParameter.instanceId/identifier error. By specifying the Identifier parameter of a client certificate or server certificate, you can query the status information of the private CA instance that issued the certificate. |
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 instances. |
|
|
object |
The object. |
||
| CertTotalCount |
integer |
The number of certificates that the private CA instance can issue. For a private root CA instance whose Type is ROOT, this parameter indicates the number of subordinate CA certificates that can be issued. For a private subordinate CA instance whose Type is SUB_ROOT, this parameter indicates the total number of client certificates and server certificates that can be issued. |
10 |
| Status |
string |
The status of the private CA instance. Valid values:
|
USED |
| Type |
string |
The type of the private CA instance. Valid values:
|
ROOT |
| CertIssuedCount |
integer |
The number of certificates that have been issued by the private CA instance. |
1 |
| BeforeTime |
integer |
The issuance date of the private CA certificate. The value is a UNIX timestamp in milliseconds. Note
This parameter is returned only when 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 when 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. The value is a UNIX timestamp in milliseconds. Note
This parameter is returned only when 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. The value is a UNIX timestamp in milliseconds. Note
This parameter corresponds to the subscription duration that you selected when you purchased the private CA instance, which is the duration of the Private Certificate Authority service. |
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.