ListUserCertificateOrder - 查询用户证书或者订单列表

查询用户证书或者订单列表。

接口说明

本接口一般用于查询用户证书或者订单列表,当 OrderType=CERT 或者 UPLOAD 时,表示查询证书列表,当 OrderType=CPACK 或者 BUY 时,表示查询订单列表。

QPS 限制

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cert:ListUserCertificateOrder

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Keyword

string

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

cert-instanceId

Status

string

订单状态。 状态取值:

  • PAYED:待申请,当 OrderType=CPACK 或者 BUY 有效。

  • CHECKING:审核中,当 OrderType=CPACK 或者 BUY 有效。

  • CHECKED_FAIL:审核失败,当 OrderType=CPACK 或者 BUY 有效。

  • ISSUED:已签发。

  • WILLEXPIRED:即将过期。

  • EXPIRED:已过期。

  • NOTACTIVATED:未激活,当 OrderType=CPACK 或者 BUY 有效。

  • REVOKED:吊销完成,当 OrderType=CPACK 或者 BUY 有效。

当 OrderType=CERT 或者 UPLOAD,Status 为空时,将默认返回有效证书,包含已签发和即将过期证书。当 OrderType=CPACK 或者 BUY,Status 为空时,将默认返回全量订单。

ISSUED

OrderType

string

资源类型。 默认为 CPACK。取值:

  • CPACK:资源虚拟订单,只返回额度生成的订单信息。

  • BUY:售卖订单,只返回售卖生成的订单信息(大部分可以忽略该类型)。

  • UPLOAD:上传证书,只返回上传证书。

  • CERT: 证书,同时返回签发证书和上传证书。

CPACK

CurrentPage

integer

分页,当前页。

1

ShowSize

integer

分页,每页展示数据条数,默认 50。

10

ResourceGroupId

string

资源组 ID。此 ID 可通过调用 ListResources 接口获取。

rg-ae******4wia

返回参数

名称

类型

描述

示例值

object

证书及订单列表返回结果。

ShowSize

integer

分页数据。

10

CurrentPage

integer

分页数据。

1

TotalCount

integer

查询数据总条数。

1

CertificateOrderList

array<object>

证书及订单列表。

{"CertificateOrderList": [{"Status": "PAYED","ProductName": "专业版通配符 OV SSL","InstanceId": "cert-instanceId","ProductCode": "globalsign-xxxx","SourceType": "buy","WildDomainCount": 1,"CertType": "OV","PartnerOrderId": "","OrderId": 3451111,"Algorithm": "RSA","RootBrand": "GlobalSign","AliyunOrderId": 21xxxxxx40655,"DomainType": "WILDCARD","TrusteeStatus": "trustee","Domain": "","BuyDate": 1632649385000,"DomainCount": 1}]}

object

证书及订单信息。

Algorithm

string

算法,当入参 OrderType=CPACK 或者 BUY 时返回。

RSA

AliyunOrderId

integer

阿里云订单号,当入参 OrderType=CPACK 或者 BUY 时返回。

234567

BuyDate

integer

购买时间。单位:毫秒,当入参 OrderType=CPACK 或者 BUY 时返回。

1634283958000

CertEndTime

integer

证书过期时间,单位:毫秒,当入参 OrderType=CPACK 或者 BUY 时返回。

1665819958000

CertStartTime

integer

证书开始时间,单位:毫秒,当入参 OrderType=CPACK 或者 BUY 时返回。

1665819958000

CertType

string

证书类型,当入参 OrderType=CPACK 或者 BUY 时返回。类型:

  • DV:DV 类型的证书。

  • EV:EV 类型的证书。

  • OV:OV 类型的证书。

  • FREE:个人测试证书(仅中国站支持)。

FREE

Domain

string

域名,当入参 OrderType=CPACK 或者 BUY 时返回。

aliyundoc.com

DomainCount

integer

购买域名总个数,当入参 OrderType=CPACK 或者 BUY 时返回。

1

DomainType

string

域名类型,当入参 OrderType=CPACK 或者 BUY 时返回。类型:

  • ONE:单域名。

  • MULTIPLE:多域名。

  • WILDCARD:单通配符域名。

  • M_WILDCARD:多通配符域名。

  • MIX:混合域名。

ONE

InstanceId

string

资源 ID。

cas-instanceId

OrderId

integer

订单 ID,当入参 OrderType=CPACK 或者 BUY 时返回。

2345687

PartnerOrderId

string

第三方 CA 订单号,当入参 OrderType=CPACK 或者 BUY 时返回。

ca-123456

ProductCode

string

订单规格 ID,当入参 OrderType=CPACK 或者 BUY 时返回。

bykj123456

ProductName

string

订单规格名称,当入参 OrderType=CPACK 或者 BUY 时返回。

CFCA

RootBrand

string

品牌(包括 WoSign、CFCA、DigiCert、vTrus 等),当入参 OrderType=CPACK 或者 BUY 时返回。

CFCA

SourceType

string

订单类型,当入参 OrderType=CPACK 或者 BUY 时返回。

  • cpack:资源虚拟订单。

  • buy:售卖订单。

buy

Status

string

订单或者证书状态,当入参 OrderType=CPACK 或者 BUY 时返回。

  • PAYED:待申请。

  • CHECKING:审核中。

  • CHECKED_FAIL:审核失败。

  • ISSUED:已签发。

  • WILLEXPIRED:即将过期。

  • EXPIRED:已过期。

  • NOTACTIVATED:未激活。

  • REVOKED:吊销完成。

PAYED

TrusteeStatus

string

托管状态,当入参 OrderType=CPACK 或者 BUY 时返回。

  • unTrustee:未托管。

  • trustee:托管。

unTrustee

WildDomainCount

integer

购买泛域名个数,当入参 OrderType=CPACK 或者 BUY 时返回。

0

CertificateId

integer

证书 ID,当入参 OrderType=CERT 或者 UPLOAD 时返回。

896521

Name

string

证书名称 ,当入参 OrderType=CERT 或者 UPLOAD 时返回。

cert-name

CommonName

string

证书的主域名,当入参 OrderType=CERT 或者 UPLOAD 时返回。

aliyun.com

Fingerprint

string

证书指纹,当入参 OrderType=CERT 或者 UPLOAD 时返回。

CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03

Sha2

string

证书 Sha2 值,当入参 OrderType=CERT 或者 UPLOAD 时返回。

56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11

SerialNo

string

证书序列号,当入参 OrderType=CERT 或者 UPLOAD 时返回。

040a6e493cffdda6d744acf99b6576cf

Issuer

string

证书签发者,当入参 OrderType=CERT 或者 UPLOAD 时返回。

MyIssuer

OrgName

string

证书组织名称,当入参 OrderType=CERT 或者 UPLOAD 时返回。

阿里云

Province

string

省或自治区,当入参 OrderType=CERT 或者 UPLOAD 时返回。

浙江省

City

string

城市,当入参 OrderType=CERT 或者 UPLOAD 时返回。

杭州市

Country

string

国家代码,当入参 OrderType=CERT 或者 UPLOAD 时返回。

CN

Sans

string

证书绑定的所有域名。多个域名之间使用半角逗号(,)分隔,当入参 OrderType=CERT 或者 UPLOAD 时返回。

aliyun.com

Expired

boolean

证书是否过期,当入参 OrderType=CERT 或者 UPLOAD 时返回。

true

Upload

boolean

证书是否上传证书,当入参 OrderType=CERT 或者 UPLOAD 时返回。

false

StartDate

string

证书开始时间,当入参 OrderType=CERT 或者 UPLOAD 时返回。

2021-11-16

EndDate

string

证书结束时间,当入参 OrderType=CERT 或者 UPLOAD 时返回。

2022-11-17

ResourceGroupId

string

资源分组 ID,当入参 OrderType=CERT 或者 UPLOAD 时返回。

rg-ae******4wia

RequestId

string

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

15C66C7B-671A-4297-9187-2C4477247A74

示例

正常返回示例

JSON格式

{
  "ShowSize": 10,
  "CurrentPage": 1,
  "TotalCount": 1,
  "CertificateOrderList": [
    {
      "Algorithm": "RSA",
      "AliyunOrderId": 234567,
      "BuyDate": 1634283958000,
      "CertEndTime": 1665819958000,
      "CertStartTime": 1665819958000,
      "CertType": "FREE",
      "Domain": "aliyundoc.com",
      "DomainCount": 1,
      "DomainType": "ONE",
      "InstanceId": "cas-instanceId",
      "OrderId": 2345687,
      "PartnerOrderId": "ca-123456",
      "ProductCode": "bykj123456",
      "ProductName": "CFCA",
      "RootBrand": "CFCA",
      "SourceType": "buy",
      "Status": "PAYED",
      "TrusteeStatus": "unTrustee",
      "WildDomainCount": 0,
      "CertificateId": 896521,
      "Name": "cert-name",
      "CommonName": "aliyun.com",
      "Fingerprint": "CC6B3696E7C7CA715BD26E28E45FF3E3DF435C03",
      "Sha2": "56B4DED2243A81DD909D7C39824FFE4DDBD87F91BFA46CD333FF212FE0E7CB11",
      "SerialNo": "040a6e493cffdda6d744acf99b6576cf",
      "Issuer": "MyIssuer",
      "OrgName": "阿里云",
      "Province": "浙江省",
      "City": "杭州市",
      "Country": "CN",
      "Sans": "aliyun.com",
      "Expired": true,
      "Upload": false,
      "StartDate": "2021-11-16",
      "EndDate": "2022-11-17",
      "ResourceGroupId": "rg-ae******4wia"
    }
  ],
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

错误码

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

变更历史

更多信息,参考变更详情