查询CA详情
功能介绍
查询CA详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/private-certificate-authorities/{ca_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ca_id |
是 |
String |
CA证书ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户token,参见:IAM token获取方法。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ca_id |
String |
CA证书ID。 |
|
type |
String |
CA类型:
|
|
status |
String |
CA证书状态:
|
|
path_length |
Integer |
CA路径长度。
说明:
注:生成的根CA证书,其路径长度不做限制,但本字段在数据库中统一置为7。从属CA的路径长度在创建时由用户指定,缺省值为0。
|
|
issuer_id |
String |
父CA证书ID,即签发此证书的CA证书ID。根CA中,此参数为null。 |
|
issuer_name |
String |
父CA证书名称。根CA中,此参数为null。 |
|
key_algorithm |
String |
密钥算法。 |
|
signature_algorithm |
String |
签名哈希算法。 |
|
freeze_flag |
Integer |
冻结标识:
|
|
gen_mode |
String |
证书生成方式:
|
|
serial_number |
String |
证书序列号。 |
|
create_time |
Long |
证书创建时间,格式为时间戳(毫秒级)。 |
|
delete_time |
Long |
证书删除时间,格式为时间戳(毫秒级)。 |
|
not_before |
Long |
证书创建时间,格式为时间戳(毫秒级)。 |
|
not_after |
Long |
证书到期时间,格式为时间戳(毫秒级)。 |
|
distinguished_name |
DistinguishedName object |
证书名称配置,详情请参见DistinguishedName字段数据结构说明。 |
|
crl_configuration |
ListCrlConfiguration object |
证书CRL配置,详情请参见ListCrlConfiguration字段数据结构说明。 |
|
enterprise_project_id |
String |
企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。 |
|
free_quota |
Integer |
免费证书配额。 |
|
charging_mode |
Integer |
计费模式:
|
|
cluster_id |
String |
dhsm集群id。 |
|
domain_id |
String |
账号ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
common_name |
String |
证书通用名称(CN),名称只能由"-"、"_"、" "、"."、","、"*"、字母、数字、汉字组成,长度不能超过64位字符。 |
|
country |
String |
国家编码,只能由英文组成,长度为2位字符。 |
|
state |
String |
省市名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 |
|
locality |
String |
地区名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 |
|
organization |
String |
组织名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 |
|
organizational_unit |
String |
组织单元名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
enabled |
Boolean |
是否启用CRL发布功能。
|
|
crl_name |
String |
吊销列表文件名称。
说明:
若用户不指定,系统将默认采用当前证书的父CA ID。
|
|
obs_bucket_name |
String |
OBS桶名称。 |
|
valid_days |
Integer |
CRL更新周期,单位为"天"。当启用CRL发布功能,为必填项。 |
|
crl_dis_point |
String |
吊销列表分发地址,即对应的OBS桶中的CRL文件地址。
说明:
本参数由程序根据crl_name、obs_bucket_name以及OBS地址进行拼接而成。
|
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 |
|
error_msg |
String |
错误请求返回的错误信息。 |
请求示例
查询CA详情,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。
GET https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificate-authorities/4c0e772e-a30c-4029-b929-b7acb04143f7
响应示例
状态码:200
请求已成功
{
"signature_algorithm" : "SHA384",
"issuer_id" : "928bd666-e879-448a-ab54-82f6ae3d81e0",
"issuer_name" : "Huawei IT Root CA",
"not_after" : 1647567892000,
"not_before" : 1645148632000,
"status" : "ACTIVED",
"freeze_flag" : 0,
"gen_mode" : "CSR",
"serial_number" : "202202180143522338893611",
"distinguished_name" : {
"country" : "CN",
"state" : "guangdong",
"locality" : "shenzhen",
"organization" : "Huawei",
"organizational_unit" : "IT",
"common_name" : "Huawei IT Root CA"
},
"key_algorithm" : "RSA",
"create_time" : 1645148633000,
"delete_time" : null,
"ca_id" : "4c0e772e-a30c-4029-b929-b7acb04143f7",
"type" : "SUBORDINATE",
"path_length" : 0,
"crl_configuration" : {
"enabled" : false,
"obs_bucket_name" : null,
"valid_days" : null,
"crl_name" : null,
"crl_dis_point" : null
},
"cluster_id" : "54d8301b-b859-4c55-a628-21fcf90e609e"
}
状态码: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 |
服务内部错误。 |
错误码
请参见错误码。