调用GetCAInstanceStatus查询您通过SSL证书服务控制台购买的私有根CA实例或私有子CA实例的状态信息。

使用说明

本接口用于通过私有CA实例的ID,查询您通过SSL证书服务控制台购买的私有CA实例的状态信息,例如,CA实例的状态、包含的证书数量、已签发的证书数量等。

调用本接口前,您必须已经通过SSL证书服务控制台购买了私有CA。具体操作,请参见购买私有CA

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetCAInstanceStatus

要执行的操作。取值:GetCAInstanceStatus

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

要查询的私有CA实例的ID。

说明 您在SSL证书服务控制台购买私有CA实例后,可以在私有证书页面,通过查看私有CA实例的详情,获取私有CA实例的ID。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String 25589516-2A56-5159-AB88-4A1D9824E183

本次请求的ID。

InstanceStatusList Array of InstanceStatus

私有CA实例的状态详情。

CertTotalCount Integer 10

私有CA实例能够签发证书的数量。

对于私有根CA实例(TypeROOT),该参数表示能够签发的子CA证书的数量。

对于私有子CA实例(TypeSUB_ROOT),该参数表示能够签发的客户端证书和服务端证书的总数量。

Status String USED

私有CA实例的状态。取值:

  • BUY:表示已购买但是未启用。
  • USED:表示已启用。
  • REFUND:表示已退款。
  • REVOKE:表示已被吊销。
Type String ROOT

私有CA实例的类型。取值:

  • ROOT:表示根CA实例。
  • SUB_ROOT:表示子CA实例。
CertIssuedCount Integer 1

私有CA实例已经签发证书的数量。

BeforeTime Long 1635177600000

私有CA证书的签发日期。使用时间戳表示,单位:毫秒。

说明 只有当StatusUSED(表示私有CA实例已启用)或REVOKE(表示私有CA实例已被吊销)时,才会返回该参数。
Identifier String a7bb2dd212a2112128cd5cc9b753****

私有CA证书的唯一标识码。

说明 只有当StatusUSED(表示私有CA实例已启用)或REVOKE(表示私有CA实例已被吊销)时,才会返回该参数。
AfterTime Long 1792944000000

私有CA证书的到期日期。使用时间戳格式表示,单位:毫秒。

说明 只有当StatusUSED(表示私有CA实例已启用)或REVOKE(表示私有CA实例已被吊销)时,才会返回该参数。
InstanceId String cas-member-0hmi****

私有CA实例的ID。

UseExpireTime Long 1637251200000

私有CA实例的到期日期。使用时间戳表示,单位:毫秒。

说明 该参数对应您在购买私有CA实例时选择的购买时长,即PCA服务的时长。

示例

请求示例

http(s)://[Endpoint]/?Action=GetCAInstanceStatus
&InstanceId=cas-member-0hmi****
&公共请求参数

正常返回示例

XML格式

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格式

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
  } ]
}

错误码

访问错误中心查看更多错误码。