更新时间:2022-05-18 GMT+08:00
分享

查询CA列表

功能介绍

查询CA列表。

调试

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

URI

GET /v1/private-certificate-authorities

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

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

最小值:0

最大值:1000

name

String

CA证书名称(CN)过滤值,用于获取名称中带有特定值的CA证书集合。

最小长度:1

最大长度:64

offset

Integer

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

最小值:0

status

String

CA证书状态,通过状态过滤证书集合:

  • EXPIRED : 待激活,此状态下,不可用于签发证书;

  • ACTIVED : 已激活,此状态下,可用于签发证书;

  • DISABLED : 已禁用,此状态下,不可用于签发证书;

  • DELETED : 计划删除,此状态下,不可用于签发证书;

  • EXPIRED : 已过期,此状态下,不可用于签发证书。

type

String

CA证书类型:

  • ROOT : 根CA证书

  • SUBORDINATE : 从属CA证书

sort_key

String

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

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

  • common_name : 证书名称

  • ca_type : CA证书类型

  • not_after : 证书到期时间

sort_dir

String

排序方向,支持以下值:

  • DESC : 降序(默认)

  • ASC : 升序

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

CA证书总数。

certificate_authorities

Array of CertificateAuthorities objects

CA列表,详情请参见CertificateAuthorities字段数据结构说明。

表4 CertificateAuthorities

参数

参数类型

描述

ca_id

String

CA证书ID。

最小长度:36

最大长度:36

type

String

CA类型:

  • ROOT: 根CA

  • SUBORDINATE: 从属CA

status

String

CA证书状态:

  • EXPIRED : 待激活,此状态下,不可用于签发证书;

  • ACTIVED : 已激活,此状态下,可用于签发证书;

  • DISABLED : 已禁用,此状态下,不可用于签发证书;

  • DELETED : 计划删除,此状态下,不可用于签发证书;

  • EXPIRED : 已过期,此状态下,不可用于签发证书。

path_length

Integer

CA路径长度。

说明:

注:生成的根CA证书,其路径长度不做限制,但本字段在数据库中统一置为7。从属CA的路径长度在创建时由用户指定,缺省值为0。

最小值:0

最大值:6

issuer_id

String

父CA证书ID,即签发此证书的CA证书ID。根CA中,此参数为null

最小长度:36

最大长度:36

issuer_name

String

父CA证书名称。根CA中,此参数为null

最小长度: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字段数据结构说明。

crl_configuration

ListCrlConfiguration object

证书CRL配置,详情请参见ListCrlConfiguration字段数据结构说明。

表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

表6 ListCrlConfiguration

参数

参数类型

描述

enabled

Boolean

是否启用CRL发布功能。

  • true

  • false

crl_name

String

吊销列表文件名称。

说明:

若用户不指定,系统将默认采用当前证书的父CA ID。

obs_bucket_name

String

OBS桶名称。

valid_days

Integer

CRL更新周期,单位为"天"。当启用CRL发布功能,为必填项。

最小值:7

最大值:30

crl_dis_point

String

吊销列表分发地址,即对应的OBS桶中的CRL文件地址。

说明:

本参数由程序根据crl_name、obs_bucket_name以及OBS地址进行拼接而成。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度:3

最大长度:36

error_msg

String

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

最小长度:0

最大长度:1024

请求示例

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

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

响应示例

状态码: 200

请求已成功

{
  "total" : 2,
  "certificate_authorities" : [ {
    "signature_algorithm" : "SHA384",
    "issuer_id" : null,
    "issuer_name" : null,
    "not_after" : 1678159435000,
    "not_before" : 1646623375000,
    "status" : "ACTIVED",
    "freeze_flag" : 0,
    "gen_mode" : "GENERATE",
    "serial_number" : "202203070322544291829058",
    "distinguished_name" : {
      "country" : "cn",
      "state" : "shanghai",
      "locality" : "shanghai",
      "organization" : "shanghai",
      "organizational_unit" : "shanghai",
      "common_name" : "CSR_123"
    },
    "key_algorithm" : "EC384",
    "create_time" : 1646623375000,
    "delete_time" : null,
    "ca_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe",
    "type" : "ROOT",
    "path_length" : 7,
    "crl_configuration" : {
      "enabled" : false,
      "obs_bucket_name" : null,
      "valid_days" : null,
      "crl_name" : null,
      "crl_dis_point" : null
    }
  }, {
    "signature_algorithm" : "SHA256",
    "issuer_id" : null,
    "issuer_name" : null,
    "not_after" : 1727492412000,
    "not_before" : 1632797952000,
    "status" : "ACTIVED",
    "freeze_flag" : 0,
    "gen_mode" : "GENERATE",
    "serial_number" : "202109280259122080649087",
    "distinguished_name" : {
      "country" : "CN",
      "state" : "Sichuan",
      "locality" : "Chengdu",
      "organization" : "Huawei",
      "organizational_unit" : "CloudBU",
      "common_name" : "pca-ca"
    },
    "key_algorithm" : "RSA2048",
    "create_time" : 1632797953000,
    "delete_time" : null,
    "ca_id" : "fb7bd6a6-6a11-4a58-8710-a3c0a620aedc",
    "type" : "ROOT",
    "path_length" : 7,
    "crl_configuration" : {
      "enabled" : false,
      "obs_bucket_name" : null,
      "valid_days" : null,
      "crl_name" : null,
      "crl_dis_point" : null
    }
  } ]
}

状态码: 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

服务内部错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close