查询私有证书列表 - ListCertificate
功能介绍
查询私有证书列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
pca:cert:list
List
-
g:EnterpriseProjectId
-
-
URI
GET /v1/private-certificates
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
指定查询返回记录条数,默认值10。 最小值:0 最大值:1000 |
|
name |
否 |
String |
私有证书名称,返回名称带有name字段的证书集合。 最小长度:1 最大长度:64 |
|
offset |
否 |
Integer |
索引位置,从offset指定的下一条数据开始查询。 最小值:0 |
|
status |
否 |
String |
私有证书状态,通过状态过滤证书集合。 |
|
sort_key |
否 |
String |
排序属性,目前支持以下属性: |
|
sort_dir |
否 |
String |
排序方向,支持以下值: |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户token,参见:IAM token获取方法。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
私有证书总数。 最小值:0 最大值:1000000 |
|
certificates |
Array of Certificates objects |
证书列表,详情请参见Certificates字段数据结构说明。 数组长度:0 - 1000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
certificate_id |
String |
私有证书ID。 最小长度:36 最大长度:36 |
|
status |
String |
证书状态: |
|
issuer_id |
String |
父CA证书ID。 最小长度:36 最大长度:36 |
|
issuer_name |
String |
父CA证书名称。 最小长度:1 最大长度:64 |
|
key_algorithm |
String |
密钥算法。 |
|
signature_algorithm |
String |
签名算法。 |
|
freeze_flag |
Integer |
冻结标识: |
|
gen_mode |
String |
证书生成方式: |
|
serial_number |
String |
序列号。 最小长度:1 最大长度:64 |
|
create_time |
Long |
证书创建时间,格式为时间戳(毫秒级)。 |
|
delete_time |
Long |
证书删除时间,格式为时间戳(毫秒级)。 |
|
not_before |
Long |
证书创建时间,格式为时间戳(毫秒级)。 |
|
not_after |
Long |
证书到期时间,格式为时间戳(毫秒级)。 |
|
distinguished_name |
DistinguishedName object |
证书名称配置,详情请参见DistinguishedName字段数据结构说明。 |
|
enc_cert_info |
EncCertInfo object |
加密证书信息,详情请参见EncCertInfo字段数据结构说明。 |
|
enterprise_project_id |
String |
企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
common_name |
String |
证书通用名称(CN),名称只能由"-"、"_"、" "、"."、","、"*"、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 |
|
country |
String |
国家编码,只能由英文组成,长度为2位字符。 最小长度:2 最大长度:2 |
|
state |
String |
省市名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 |
|
locality |
String |
地区名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 |
|
organization |
String |
组织名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 |
|
organizational_unit |
String |
组织单元名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误请求返回的错误码。 最小长度:3 最大长度:36 |
|
error_msg |
String |
错误请求返回的错误信息。 最小长度:0 最大长度:1024 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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",
"enc_cert_info" : {
"enc_serial_number" : "2ad6c3e393a95bf13f95"
}
}, {
"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",
"enc_cert_info" : {
"enc_serial_number" : "448ad305b90e0a266e9"
}
} ]
}
状态码: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"
}
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.ccm.v1.region.CcmRegion; import com.huaweicloud.sdk.ccm.v1.*; import com.huaweicloud.sdk.ccm.v1.model.*; public class ListCertificateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CcmClient client = CcmClient.newBuilder() .withCredential(auth) .withRegion(CcmRegion.valueOf("<YOUR REGION>")) .build(); ListCertificateRequest request = new ListCertificateRequest(); try { ListCertificateResponse response = client.listCertificate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkccm.v1.region.ccm_region import CcmRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkccm.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = CcmClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcmRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListCertificateRequest() response = client.list_certificate(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" ccm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ccm/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ccm/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ccm/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := ccm.NewCcmClient( ccm.CcmClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListCertificateRequest{} response, err := client.ListCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
|
400 |
请求参数有误。 |
|
401 |
被请求的页面需要鉴权。 |
|
403 |
认证失败。 |
|
404 |
资源不存在或资源未找到。 |
|
500 |
服务内部错误。 |
错误码
请参见错误码。