AI 助理
文档备案控制台
官方文档
首页 数字证书管理服务（原SSL证书） 开发参考 API参考（SSL证书） API目录 订阅实例 GetInstanceDetail - 获取实例详情

GetInstanceDetail - 获取实例详情

更新时间：
复制 MD 格式
产品详情
我的收藏

查询实例详情。

接口说明

本接口用于通过私有 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:GetInstanceDetail

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
InstanceId

string

是

实例的 ID。

cas_dv-cn-123

InstanceId 是通过 BSS 购买证书套餐后由 ListInstances 获取，需先在 CAS 控制台或通过 BSS API 完成购买。cas-upload-*格式的需调用 UploadUserCertificate 接口上传证书获取实例 ID。

返回参数

名称

类型

描述

示例值

object

AutoReissue

string

是否开启自动托管。

  • enable：开启

  • disable：未开启

enable
AutoReissueFlag

integer

当前版本是否已包含自动托管： 1：已包含 0：未包含。

1
AverageWaitingTime

string

签发该规格证书平均等待时长，单位秒。

120
Brand

string

CA 品牌。WoSign、CFCA、DigiCert、GeoTrust、GlobalSign、vTrus、Alibaba。

DigiCert
CertIdentifier

string

全局证书 ID，格式为证书 Id + "-" + 站点 regionId，常用在阿里云各个云产品中。 --国内站为证书 Id + "-cn-hangzhou" 国际站为证书 Id + "-ap-southeast-1" 例如证书 Id = 123，则国内站 CertIdentifier = “123-cn-hangzhou”，国际站 CertIdentifier = "123-ap-southeast-1"。

22783111-cn-hangzhou
CertificateId

integer

证书 ID。

1234567890
CertificateName

string

实例的名称，签发证书时则为作为证书的默认名称。

123
CertificateNotAfter

integer

最新证书的结束时间，时间戳。未签发证书则为空。精确到秒。

1801324800000
CertificateNotBefore

integer

最新证书的开始时间，时间戳。未签发证书则为空。精确到秒。

1781568000000
CertificateRevokeTime

integer

最新一张证书吊销时间，时间戳，精确到秒。

1801324800000
CertificateStatus

string

证书的状态

  • issued：已签发

  • revoked：已吊销

  • willExpire：即将过期

  • expired：已过期

issued
CertificateType

string

证书的类型。取值：DV、OV、EV。

DV
City

string

购买证书的用户所属的公司或组织所在的城市。生成 CSR 时需要该字段。默认为 Beijing。

Beijing
CompanyId

integer

公司信息 ID。

47305
ContactIdList

array

联系人 ID 列表。

integer

联系人 ID。

123
CountryCode

string

设置证书组织机构所在国家或地区的代码。例如，CN 表示中国，US 表示美国。生成 CSR 时需要该字段，默认为 CN。

CN
Csr

string

PEM 格式的证书请求。

-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
DeploymentResourceCount

integer

已部署云产品资源数。

30
DeploymentUseCount

integer

云服务器部署已使用额度。

30
DingGroupList

array<object>

关联的专家服务钉钉群列表。

object

关联的专家服务钉钉群。

DingGroupInstanceId

string

专家服务钉钉群实例 id。

123
DingGroupName

string

专家服务钉钉群名称。

123
DingGroupType

string

专家服务钉钉群类型。

  • expedite 协助申请

  • remote 线下部署

remote
DingGroupUrl

string

专家服务钉钉群入群链接。

https://123.com
Domain

string

证书绑定的域名。

example.com
DomainValidationList

array<object>

验证域名列表。

object

验证域名。

Cname

string

免验证授权的 Cname 记录值。可能返回空。

123.com
CnameKey

string

cname 验证时的前缀。

abc
Domain

string

要验证的域名。

example.com
RootDomain

string

根域名。

example.com
ValidationKey

string

主机记录。

@
ValidationType

string

验证类型，TXT、HTTP、CNAME。

TXT
ValidationValue

string

验证主机记录值。

123
FullDomainCount

integer

精准域名数量。

1
GenerateCsrMethod

string

CSR 生成方式。

  • online：系统生成，则会忽略 Csr 字段。

  • upload：未开启，用户上传，则要求 Csr 为必填。

online
InstanceEndTime

integer

实例的到期时间，时间戳。如果未签发过证书，则返回空。精确到秒。

1801324800000
InstanceId

string

实例的 ID。

cas_dv-cn-123
InstanceStartTime

integer

实例的开始时间，时间戳。如果未签发过证书，则返回空。精确到秒。

1801324800000
InstanceType

string

实例类型，BUY：正式证书；TEST：测试证书。

TEST
KeyAlgorithm

string

证书算法。

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • ECC_256

  • SM2

RSA_2048
MonitorExpandFlag

integer

是否可扩容域名监控额度。 1：是 0：否。

1
MonitorUseCount

integer

域名监控已使用额度。

10
OrderEndTime

integer

实例购买时的结束时间，时间戳，用来判断实例的购买时长。

1801324800000
OrderStartTime

integer

实例购买时的开始时间，时间戳，用来判断退款时间限制，精确到秒。

1801324800000
PendingResult

string

最后一次操作证书时，CA 返回的结果。

pending
Province

string

公司所在省份或者地区。生成 CSR 时需要该字段，默认为 Beijing。

Beijing
RequestId

string

本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9
ResourceGroupId

string

资源组 id。

rg-aek****wia
Spec

string

购买的实例规格。

ss.dv.t
Status

string

实例状态。

  • inactive：待使用

  • pending：审核中，最新证书提交审核中

  • willExpire：实例即将过期

  • expired：实例已经过期

  • refund：已退款

  • normal：正常

  • closed：已关闭，不可使用

inactive
Tags

array<object>

标签列表。

object

标签列表。

TagKey

string

标签 Key。

test
TagValue

string

标签值。

test
TotalDeploymentCount

integer

云服务器部署总额度。

60
TotalMonitorCount

integer

域名监控总额度。

80
UpgradeStatus

string

实例升级状态。

  • none：实例未升级

  • payed：实例升级已经付款

  • issued：实例升级已签发最新证书

none
ValidationMethod

string

申请证书验证方式。

  • DNS：DNS 验证方式，TXT 或者 CNAME。

  • HTTP：文件验证方式。

DNS
VersionType

string

版本类型。支持：FOTA：系统升级 APP：应用升级

0
WildcardDomainCount

integer

通配符域名的数量。

0

示例

正常返回示例

JSON格式

{
  "AutoReissue": "enable",
  "AutoReissueFlag": 1,
  "AverageWaitingTime": "120",
  "Brand": "DigiCert",
  "CertIdentifier": "22783111-cn-hangzhou",
  "CertificateId": 1234567890,
  "CertificateName": "123",
  "CertificateNotAfter": 1801324800000,
  "CertificateNotBefore": 1781568000000,
  "CertificateRevokeTime": 1801324800000,
  "CertificateStatus": "issued",
  "CertificateType": "DV",
  "City": "Beijing",
  "CompanyId": 47305,
  "ContactIdList": [
    123
  ],
  "CountryCode": "CN",
  "Csr": "-----BEGIN CERTIFICATE REQUEST-----   ...... -----END CERTIFICATE REQUEST-----",
  "DeploymentResourceCount": 30,
  "DeploymentUseCount": 30,
  "DingGroupList": [
    {
      "DingGroupInstanceId": "123",
      "DingGroupName": "123",
      "DingGroupType": "remote",
      "DingGroupUrl": "https://123.com"
    }
  ],
  "Domain": "example.com",
  "DomainValidationList": [
    {
      "Cname": "123.com",
      "CnameKey": "abc",
      "Domain": "example.com",
      "RootDomain": "example.com",
      "ValidationKey": "@",
      "ValidationType": "TXT",
      "ValidationValue": "123"
    }
  ],
  "FullDomainCount": 1,
  "GenerateCsrMethod": "online",
  "InstanceEndTime": 1801324800000,
  "InstanceId": "cas_dv-cn-123",
  "InstanceStartTime": 1801324800000,
  "InstanceType": "TEST",
  "KeyAlgorithm": "RSA_2048",
  "MonitorExpandFlag": 1,
  "MonitorUseCount": 10,
  "OrderEndTime": 1801324800000,
  "OrderStartTime": 1801324800000,
  "PendingResult": "pending",
  "Province": "Beijing",
  "RequestId": "B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9",
  "ResourceGroupId": "rg-aek****wia",
  "Spec": "ss.dv.t",
  "Status": "inactive",
  "Tags": [
    {
      "TagKey": "test",
      "TagValue": "test"
    }
  ],
  "TotalDeploymentCount": 60,
  "TotalMonitorCount": 80,
  "UpgradeStatus": "none",
  "ValidationMethod": "DNS",
  "VersionType": "0",
  "WildcardDomainCount": 0
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：UpdateInstance - 更新实例下一篇：DeleteInstance - 删除实例