更新时间:2022-03-29 GMT+08:00
分享

查询私有证书列表

功能介绍

查询私有证书列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/private-certificates

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

指定查询返回记录条数,默认值10。

最小值:0

最大值:1000

name

String

私有证书名称,返回名称带有name字段的证书集合。

最小长度:1

最大长度:64

offset

Integer

索引位置,从offset指定的下一条数据开始查询。

最小值:0

status

String

私有证书状态,通过状态过滤证书集合。

  • ISSUED : 已签发;

  • REVOKED : 已吊销;

  • EXPIRED : 已过期。

sort_key

String

排序属性,目前支持以下属性:

  • create_time : 证书创建时间(默认)

  • common_name : 证书名称

  • issuer_name : 签发CA名称

  • not_after : 证书到期时间

sort_dir

String

排序方向,支持以下值:

  • DESC : 降序(默认)

  • ASC : 升序

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户token,参见:IAM token获取方法

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

私有证书总数。

最小值:0

最大值:1000000

certificates

Array of Certificates objects

证书列表,详情请参见Certificates字段数据结构说明。

表4 Certificates

参数

参数类型

描述

certificate_id

String

私有证书ID。

最小长度:36

最大长度:36

status

String

证书状态:

  • ISSUED : 已签发;

  • EXPIRED : 已过期;

  • REVOKED : 已吊销。

issuer_id

String

父CA证书ID。

最小长度:36

最大长度:36

issuer_name

String

父CA证书名称。

最小长度:1

最大长度:64

key_algorithm

String

密钥算法。

signature_algorithm

String

签名算法。

freeze_flag

Integer

冻结标识:

  • 0 : 非冻结状态;

  • 其它值 : 冻结状态,当前预留。

gen_mode

String

证书生成方式:

  • GENERATE : PCA系统生成;

  • IMPORT : 外部导入;

  • CSR : 外部提供CSR,内部CA进行签发,即私钥不在PCA进行托管。

serial_number

String

序列号。

最小长度:1

最大长度:64

create_time

Long

证书创建时间,格式为时间戳(毫秒级)。

delete_time

Long

证书删除时间,格式为时间戳(毫秒级)。

not_before

Long

证书创建时间,格式为时间戳(毫秒级)。

not_after

Long

证书到期时间,格式为时间戳(毫秒级)。

distinguished_name

DistinguishedName object

证书名称配置,详情请参见DistinguishedName字段数据结构说明。

表5 DistinguishedName

参数

参数类型

描述

common_name

String

证书通用名称(CN)。

最小长度:1

最大长度:64

country

String

国家编码,需符合正则"[A-Za-z]{2}"。

最小长度:2

最大长度:2

state

String

省市名称。

最小长度:1

最大长度:128

locality

String

地区名称。

最小长度:1

最大长度:128

organization

String

组织名称。

最小长度:1

最大长度:64

organizational_unit

String

组织单元名称。

最小长度:1

最大长度:64

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

错误请求返回的错误信息。

最小长度:0

最大长度:1024

请求示例

查询私有证书列表,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。

GET https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates

响应示例

状态码: 200

请求已成功

{
  "total" : 2,
  "certificates" : [ {
    "signature_algorithm" : "SHA256",
    "issuer_id" : "ef5d84d1-4f52-47d2-b1c8-a91a672487a0",
    "issuer_name" : "12",
    "not_after" : 1665539214000,
    "not_before" : 1634295475000,
    "status" : "ISSUED",
    "freeze_flag" : 0,
    "gen_mode" : "GENERATE",
    "serial_number" : "202110151057541266081861",
    "distinguished_name" : {
      "country" : "cn",
      "state" : "guizhou",
      "locality" : "guiyang",
      "organization" : "hw",
      "organizational_unit" : "IT",
      "common_name" : "test.huawei.com"
    },
    "key_algorithm" : "RSA4096",
    "create_time" : 1634295475000,
    "delete_time" : null,
    "certificate_id" : "6434f74f-2d13-4e6a-89eb-93ee313f1a43"
  }, {
    "signature_algorithm" : "SHA256",
    "issuer_id" : "ef5d84d1-4f52-47d2-b1c8-a91a672487a0",
    "issuer_name" : "12",
    "not_after" : 1665539214000,
    "not_before" : 1634110315000,
    "status" : "ISSUED",
    "freeze_flag" : 0,
    "gen_mode" : "GENERATE",
    "serial_number" : "202110130731541908887138",
    "distinguished_name" : {
      "country" : "cn",
      "state" : "sichuan",
      "locality" : "chengdu",
      "organization" : "hw",
      "organizational_unit" : "HR",
      "common_name" : "hr.huawei.com"
    },
    "key_algorithm" : "RSA4096",
    "create_time" : 1634110316000,
    "delete_time" : null,
    "certificate_id" : "1cbb5a52-806b-469c-b182-7446e1851a1c"
  } ]
}

状态码: 400

请求参数有误。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码: 401

被请求的页面需要鉴权。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码: 403

认证失败。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码: 404

资源不存在或资源未找到。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码: 500

服务内部错误。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误。

401

被请求的页面需要鉴权。

403

认证失败。

404

资源不存在或资源未找到。

500

服务内部错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读