ListCertificates - 证书列表

更新时间:
复制 MD 格式

获取证书列表

接口说明

本接口用于查询 CA 证书(包括根 CA 证书和子 CA 证书)的操作日志,例如,CA 证书的创建日志、状态修改日志。

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cert:ListCertificates

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Keyword

string

否

模糊查询,匹配域名、名称和对应的资源 ID。

test

InstanceId

string

否

实例的 ID。

cas-ivauto-hqito6

CertificateStatus

string

否

证书的状态

  • issued:已签发

  • revoked:已吊销

  • willExpire:即将过期

  • expired:已过期

issued

CertificateSource

string

否

证书来源。

  • BUY 正式证书。

  • TEST 测试证书。

  • UPLOAD 上传证书。

BUY

ResourceGroupId

string

否

资源组 id。

rg-aek****wia

ShowSize

integer

否

分页数据,默认为 10,最大为 100。

10

CurrentPage

integer

否

当前页的页码。

1

返回参数

名称

类型

描述

示例值

object

CertificateList

array<object>

证书显示列表。

object

证书信息。

Algorithm

string

证书的加密算法类型。取值:

  • RSA:表示 RSA 算法。

  • ECC:表示 ECC 算法。

  • SM2:表示 SM2(国密)算法。

RSA

CertIdentifier

string

全局证书 ID,格式为证书 Id + "-" + 站点 regionId,常用在阿里云各个云产品中。

  • 国内站为证书 Id + "-cn-hangzhou"

  • 国际站为证书 Id + "-ap-southeast-1"

例如证书 Id = 123,则国内站 CertIdentifier = “123-cn-hangzhou”,国际站 CertIdentifier = "123-ap-southeast-1"。

21589515-cn-hangzhou

CertificateId

string

证书 ID。

17281539

CertificateName

string

证书名称。

test

CertificateSource

string

证书来源。

  • BUY 正式证书。

  • TEST 测试证书。

  • UPLOAD 上传证书。

BUY

CertificateStatus

string

证书的状态

  • issued:已签发

  • revoked:已吊销

  • willExpire:即将过期

  • expired:已过期

issued

CommonName

string

证书通用名称。

aliyun.com

DeploymentDesc

string

部署信息,Json 格式:

--Scope:取值 all/server。证书有密钥时取值 all,没有密钥,取值 server。

--ServerName:证书实例关联的服务器的名称。

--ResourceInstanceId:证书实例关联的服务器的资源标识。

{ "Scope": "all", "ServerName": "acmeServerName", "ResourceInstanceId": "cas_dv-cn-XXX" }

Domain

string

证书绑定的域名,多个域名逗号分隔。

test.com

ExistPrivateKey

boolean

证书是否存在私钥。取值:

  • true

  • false

true

FingerPrint

string

公钥指纹。

123

InstanceId

string

证书实例 ID。

cas-cn-v***

Issuer

string

证书颁发机构。

DigiCert

KeySize

integer

密钥算法长度。

  • RSA 算法长度一般为 2048、3072、4096 等。

  • ECC 和 SM2 算法长度一般为 256。

2048

NotAfter

integer

证书有效期的截止时间。

1749580567000

NotBefore

integer

证书有效期的开始时间。

1760745600000

Serial

string

证书序列号。

123

SubjectAlternativeNames

array

数组格式,返回证书的备用域名列表,对应证书的Subject Alternative Name字段。

string

证书的备用域名。

test.com

UsingProductList

array

当前证书正在部署的云产品列表。

string

云产品。

CDN

CurrentPage

integer

分页。当前页,默认 1。

1

RequestId

string

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

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

ShowSize

integer

分页数据。

10

TotalCount

integer

总记录数。

10

示例

正常返回示例

JSON格式

{
  "CertificateList": [
    {
      "Algorithm": "RSA",
      "CertIdentifier": "21589515-cn-hangzhou",
      "CertificateId": "17281539",
      "CertificateName": "test",
      "CertificateSource": "BUY",
      "CertificateStatus": "issued",
      "CommonName": "aliyun.com",
      "DeploymentDesc": "{\n      \"Scope\": \"all\",\n       \"ServerName\": \"acmeServerName\",\n       \"ResourceInstanceId\": \"cas_dv-cn-XXX\"\n}",
      "Domain": "test.com",
      "ExistPrivateKey": true,
      "FingerPrint": "123",
      "InstanceId": " cas-cn-v***",
      "Issuer": "DigiCert",
      "KeySize": 2048,
      "NotAfter": 1749580567000,
      "NotBefore": 1760745600000,
      "Serial": "123",
      "SubjectAlternativeNames": [
        "test.com"
      ],
      "UsingProductList": [
        "CDN"
      ]
    }
  ],
  "CurrentPage": 1,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "ShowSize": 10,
  "TotalCount": 10
}

错误码

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

变更历史

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