You need to enable JavaScript to run this app.
文档中心
证书中心

证书中心

复制全文
下载 pdf
私有证书
GetLeafInstance - 查询私有证书实例详情
复制全文
下载 pdf
GetLeafInstance - 查询私有证书实例详情

调用本接口查询指定私有证书实例的详情。

请求说明

  • 接口名称:GetLeafInstance
  • 请求方式:GET
  • 请求地址:
    • IPv4网络接入:pca.volcengineapi.com
    • 双栈网络接入(IPv4/IPv6):pca.volcengine-api.com

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

GetLeafInstance

要执行的操作,取值:GetLeafInstance。

Version
String

2025-10-01

API的版本,取值:2025-10-01。

InstanceId
String

pca_leaf_M6gaihuZRcO****

要查询的私有证书实例的ID。
您可以调用 ListLeafInstances 接口获取所有私有证书实例的ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
InstanceId
String

pca_leaf_M6gaihuZRcO****

私有证书实例的ID。

SubCaId
String

pca_sub_MlRaK****

对应的私有子CA实例的ID。

RootCaId
String

pca_root_aXPEF****

对应的私有根CA实例的ID。

EncryptionAlgorithm
String

RSA 2048

私有证书的密钥算法。

SignatureAlgorithm
String

SHA512-RSA

私有证书的签名算法。

SerialNumber
String

39E8CBC731E467DBA6DA3B3F36D51FF3A2D34FB

私有证书的序列号。

Tag
String

doc-test-PrivateCert

私有证书的备注。

Subject
Object

-

私有证书的主题信息。

Extension
Object

-

扩展信息。

Contact
Object

-

联系人信息。

CommonName
String

www.example.com

私有证书的公用名。

Certificate
Object

-

私有证书的内容。

CreateAt
String

1678794684

私有证书实例的创建时间。使用秒级时间戳表示。

InstanceStatus
Integer

1

实例的状态。该参数有以下取值:

  • 1:正常运行
  • 4:已吊销
Duration
String

10天

私有证书的有效时长。

Plan
String

basic

私有证书的规格。

SourceType
Integer

0

子CA证书的来源。该参数有以下取值:

  • 0:在证书中心创建
  • 1:上传到证书中心
Tags
Array of Object

-

私有证书的标签信息。

ProjectName
String

default

私有证书归属的项目组。

NotAfter
Integer

1681401599

私有证书过期的时间。使用秒级时间戳表示。

NotBefore
Integer

1678778206

私有证书开始生效的时间。使用秒级时间戳表示。

请求示例

POST /?Action=GetLeafInstance&Version=2025-10-01&InstanceId=pca_leaf_M6gaihuZRcO**** HTTP/1.1
Host: pca.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251030T061354Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251030/cn-beijing/pca/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20251030141358226045118114F30338",
    "Action": "GetLeafInstance",
    "Version": "2025-10-01",
    "Service": "pca",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceId": "pca_leaf_M6gaihuZRcO****",
    "SubCaId": "pca_sub_MlRaK****",
    "RootCaId": "pca_root_aXPEF****",
    "EncryptionAlgorithm": "RSA 2048",
    "SignatureAlgorithm": "SHA512-RSA",
    "SerialNumber": "39E8CBC731E467DBA6DA3B3F36D51FF3A2D34FB",
    "Tag": "doc-test-PrivateCert",
    "Subject": {
      "Country": [
        "CN"
      ],
      "Organization": [
        "Volcano\n"
      ],
      "OrganizationalUnit": [
        "ti"
      ],
      "Locality": [
        "海淀"
      ],
      "Province": [
        "北京"
      ],
      "StreetAddress": [
        "某某路某某号"
      ],
      "PostalCode": [
        "100080"
      ],
      "SerialNumber": "39E8CBC731E467DBA6DA3B3F36D51FF3A2D34FB",
      "CommonName": "www.example.com"
    },
    "Extension": {
      "SubjectAlternativeName": {
        "DnsNames": [
          "[\"example.com\", \"www.example.com\"]"
        ],
        "IpAddresses": [
          "[\"192.168.1.1\", \"2408:8888::1\"]"
        ],
        "Uris": [
          "[\"urn:example:service\", \"https://service.example.com\"]"
        ],
        "EmailAddresses": [
          "[\"admin@example.com\"]"
        ]
      }
    },
    "Contact": {
      "Name": "张三",
      "Email": "zhangsan@example.com",
      "PhoneNumber": "131****1111"
    },
    "CommonName": "www.example.com",
    "Certificate": {
      "Csr": "null",
      "EncryptKey": "null",
      "EncryptChain": [
        "null"
      ],
      "Key": "null",
      "Chain": [
        "`-----BEGIN CERTIFICATE----- MIID……SI4= -----END CERTIFICATE----- \",\"-----BEGIN CERTIFICATE----- MIID……XWlZ -----END CERTIFICATE----- \",\"-----BEGIN CERTIFICATE----- MIID……l+o= -----END CERTIFICATE-----`"
      ]
    },
    "CreateAt": "1678794684",
    "InstanceStatus": 1,
    "Duration": "10天",
    "Plan": "basic",
    "SourceType": 0,
    "Tags": [
      {
        "Key": "env",
        "Value": "test"
      }
    ],
    "ProjectName": "default",
    "NotAfter": 1681401599,
    "NotBefore": 1678778206
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
MissingParameter

The required parameter %s is missing.

缺少必填参数。

200
InternalError

The request has failed due to an unknown error.

未知错误。

最近更新时间:2026.01.07 17:39:54
这个页面对您有帮助吗?
有用
有用
无用
无用