调用ListClientCertificate查询所有客户端证书和服务端证书的详细信息。

使用说明

本接口用于分页查询您已创建的所有客户端证书和服务端证书的详细信息,例如,证书的唯一识别码、序列号、使用者信息、内容、状态等。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListClientCertificate

要执行的操作。取值:ListClientCertificate

CurrentPage Integer 1

分页查询时,设置当前页面的页码。默认值为1

ShowSize Integer 20

分页查询时,设置每页显示证书的数量。默认值为20

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
CurrentPage Integer 1

当前页面的页码。

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

本次请求的ID。

TotalCount Integer 1

查询到的客户端证书和服务端证书的总数量。

PageCount Integer 1

总页数。

ShowSize Integer 20

每页显示证书的数量。

CertificateList Array of Certificate

客户端证书或服务端证书的详情列表。

Status String ISSUE

证书的状态。取值:

  • ISSUE:表示正常签发。
  • REVOKE:表示已被吊销。
SerialNumber String 62b2b943a32d96883a6650e672ea0276****

证书的序列号。

CertificateType String SERVER

证书的类型。取值:

  • CLIENT:表示客户端证书。
  • SERVER:表示服务端证书。
Algorithm String RSA

证书的加密算法类型。取值:

  • RSA:表示RSA算法。
  • ECC:表示ECC算法。
  • SM2:表示SM2(国密)算法。
State String Zhejiang

签发该证书的子CA证书关联的组织机构所在省份、直辖市或自治区的名称。

Organization String 阿里云计算有限公司

签发该证书的子CA证书关联的组织机构的名称。

ParentIdentifier String 160ae6bb538d538c70c01f81dcf2****

签发该证书的子CA证书的唯一识别码。

Locality String Hangzhou

签发该证书的子CA证书关联的组织机构所在城市的名称。

Identifier String d3b95700998e47afc4d95f886579****

证书的唯一识别码。

Sans String [ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]

证书的SAN(Subject Alternative Name)扩展属性,表示证书关联的其他域名、IP地址等。

该参数使用JSON数组转化的字符串表示。JSON数组中的每个元素是一个结构体,对应一个SAN扩展。

每个SAN扩展结构体包含以下参数:

  • Type:Integer类型,表示扩展的类型。取值:
    • 1:表示邮箱地址。
    • 2:表示域名。
    • 6:表示统一资源标识符URI(Uniform Resource Identifier)。
    • 7:表示IP地址。
  • Value:String类型,表示扩展的内容。
Days Integer 365

证书的有效期。单位:天。

KeySize Integer 4096

证书的密钥长度。

X509Certificate String -----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----

证书的内容。

SubjectDN String C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun

证书的DN(Distinguished Name)属性,表示证书的使用者,具体包含以下信息:

  • C:国家。
  • O:组织机构。
  • OU:部门。
  • L:城市。

  • ST:省份、直辖市或自治区。

  • CN:公用名。
SignAlgorithm String SHA256WITHRSA

证书的签名算法。

OrganizationUnit String Security

签发该证书的子CA证书关联的组织机构下部门的名称。

AfterDate Long 1665819958000

证书的到期日期。使用时间戳表示,单位:毫秒。

Sha2 String 14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****

证书的SHA256数字指纹。

CommonName String aliyundoc.com

证书的公用名。

Md5 String d3b95700998e47afc4d95f886579****

证书的MD5数字指纹。

CountryCode String CN

签发该证书的子CA证书关联的组织机构所在国家的代码。

关于不同国家代码的含义,请参见管理公司信息中的国际代号章节。

BeforeDate Long 1634283958000

证书的签发日期。使用时间戳表示,单位:毫秒。

示例

请求示例

http(s)://[Endpoint]/?Action=ListClientCertificate
&CurrentPage=1
&ShowSize=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListClientCertificateResponse>
    <CurrentPage>1</CurrentPage>
    <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
    <TotalCount>1</TotalCount>
    <PageCount>1</PageCount>
    <ShowSize>20</ShowSize>
    <CertificateList>
        <Status>ISSUE</Status>
        <SerialNumber>62b2b943a32d96883a6650e672ea0276****</SerialNumber>
        <CertificateType>SERVER</CertificateType>
        <Algorithm>RSA</Algorithm>
        <State>Zhejiang</State>
        <Organization>阿里云计算有限公司</Organization>
        <ParentIdentifier>160ae6bb538d538c70c01f81dcf2****</ParentIdentifier>
        <Locality>Hangzhou</Locality>
        <Identifier>d3b95700998e47afc4d95f886579****</Identifier>
        <Sans>[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]</Sans>
        <Days>365</Days>
        <KeySize>4096</KeySize>
        <X509Certificate>-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----</X509Certificate>
        <SubjectDN>C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun</SubjectDN>
        <SignAlgorithm>SHA256WITHRSA</SignAlgorithm>
        <OrganizationUnit>Security</OrganizationUnit>
        <AfterDate>1665819958000</AfterDate>
        <Sha2>14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****</Sha2>
        <CommonName>aliyundoc.com</CommonName>
        <Md5>d3b95700998e47afc4d95f886579****</Md5>
        <CountryCode>CN</CountryCode>
        <BeforeDate>1634283958000</BeforeDate>
    </CertificateList>
</ListClientCertificateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CurrentPage" : 1,
  "RequestId" : "15C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount" : 1,
  "PageCount" : 1,
  "ShowSize" : 20,
  "CertificateList" : [ {
    "Status" : "ISSUE",
    "SerialNumber" : "62b2b943a32d96883a6650e672ea0276****",
    "CertificateType" : "SERVER",
    "Algorithm" : "RSA",
    "State" : "Zhejiang",
    "Organization" : "阿里云计算有限公司",
    "ParentIdentifier" : "160ae6bb538d538c70c01f81dcf2****",
    "Locality" : "Hangzhou",
    "Identifier" : "d3b95700998e47afc4d95f886579****",
    "Sans" : "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
    "Days" : 365,
    "KeySize" : 4096,
    "X509Certificate" : "-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----",
    "SubjectDN" : "C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
    "SignAlgorithm" : "SHA256WITHRSA",
    "OrganizationUnit" : "Security",
    "AfterDate" : 1665819958000,
    "Sha2" : "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
    "CommonName" : "aliyundoc.com",
    "Md5" : "d3b95700998e47afc4d95f886579****",
    "CountryCode" : "CN",
    "BeforeDate" : 1634283958000
  } ]
}

错误码

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