文档

GetCAInstanceStatus - 查询CA实例的状态信息

更新时间:

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

接口说明

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

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

QPS限制

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cert:GetCAInstanceStatusRead
  • 全部资源
    acs:yundun-cert:*:{#accountId}:*

请求参数

名称类型必填描述示例值
InstanceIdstring

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

说明 您在数字证书管理服务控制台购买私有CA实例后,可以在私有证书页面,通过查看私有CA实例的详情,获取私有CA实例的ID。
cas-member-0hmi****
Identifierstring

要查询的客户端证书或服务端证书的唯一识别码。

说明 您可以调用ListClientCertificate查询所有客户端证书和服务端证书的唯一识别码。
160ae6bb538d538c70c01f81dcf2****

返回参数

名称类型描述示例值
object

对象。

RequestIdstring

本次请求的ID。

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

私有CA实例的状态详情。

CertTotalCountinteger

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

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

10
Statusstring

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

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

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

  • ROOT:表示根CA实例。
  • SUB_ROOT:表示子CA实例。
ROOT
CertIssuedCountinteger

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

1
BeforeTimelong

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

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

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

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

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

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

私有CA实例的ID。

cas-member-0hmi****
UseExpireTimelong

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

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-05OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Identifier