GetRootInstance - 查询根CA实例详情--证书中心-火山引擎

文档中心

证书中心

私有根CA

GetRootInstance - 查询根CA实例详情

调用本接口查询指定私有根CA（以下简称“根CA”）实例的详情。

请求说明

接口名称：GetRootInstance
请求方式：GET
请求地址：
- IPv4网络接入：pca.volcengineapi.com
- 双栈网络接入（IPv4/IPv6）：pca.volcengine-api.com

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetRootInstance	要执行的操作，取值：GetRootInstance。
Version	String	是	2025-10-01	API的版本，取值：2025-10-01。
InstanceId	String	是	pca_root_aXPEF****	要查询的根CA实例的ID。您可以调用 ListRootInstances 接口获取所有根CA实例的ID。

返回参数

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

参数	类型	示例值	描述
InstanceId	String	pca_root_aXPEF****	根CA实例的ID。
EncryptionAlgorithm	String	RSA 2048	根CA证书的密钥算法。
SignatureAlgorithm	String	SHA256-RSA	根CA证书的签名算法。
SerialNumber	String	331D4CD014E4813AB8302E47DD9EB436DE2E7BDE	根CA证书的序列号。
Tag	String	doc-test-RootCA	根CA证书的备注。
Contact	Object	-	根CA证书的联系人信息。
Subject	Object	-	根CA证书的主题信息。
CommonName	String	Volcengine CA	公用名（CN）。
Certificate	Object	-	证书信息
NotAfter	Integer	1681401599	根CA证书过期的时间。使用秒级时间戳表示。
NotBefore	Integer	1678778206	根CA证书开始生效的时间。使用秒级时间戳表示。
CreateAt	String	1678778206	根CA实例的创建时间。使用秒级时间戳表示。
InstanceStatus	Integer	1	实例的状态。该参数有以下取值： 0：未知 1：已启用 2：已停用 4：已吊销 8：已冻结（实例欠费） 16：已过期
Duration	String	30天	根CA实例的购买时长。
SourceType	Integer	0	根CA证书的来源。该参数有以下取值： 0：在证书中心创建 1：上传到证书中心
Plan	String	Standard	证书规格。
ProjectName	String	default	资源所属项目。
Tags	Array of Object	-	资源关联的标签。

请求示例

POST /?Action=GetRootInstance&Version=2025-10-01&InstanceId=pca_root_aXPEF**** HTTP/1.1
Host: pca.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251030T040935Z
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": "2025103012093806306407408137B81F",
    "Action": "GetRootInstance",
    "Version": "2025-10-01",
    "Service": "pca",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceId": "pca_root_aXPEF****",
    "EncryptionAlgorithm": "RSA 2048",
    "SignatureAlgorithm": "SHA256-RSA",
    "SerialNumber": "331D4CD014E4813AB8302E47DD9EB436DE2E7BDE",
    "Tag": "doc-test-RootCA",
    "Contact": {
      "Name": "张三",
      "Email": "zhangsan@example.com",
      "PhoneNumber": "131****1111"
    },
    "Subject": {
      "Country": [
        "CN"
      ],
      "Organization": [
        "Volcengine"
      ],
      "OrganizationalUnit": [
        "ti"
      ],
      "Locality": [
        "海淀"
      ],
      "Province": [
        "北京"
      ],
      "StreetAddress": [
        "某某路某某号"
      ],
      "PostalCode": [
        "100080"
      ],
      "SerialNumber": "331D4CD014E4813AB8302E47DD9EB436DE2E7BDE",
      "CommonName": "Volcengine CA"
    },
    "CommonName": "Volcengine CA",
    "Certificate": {
      "Csr": "null",
      "EncryptKey": "-----BEGIN RSA PRIVATE KEY----- MIIE......Ow== -----END RSA PRIVATE KEY-----",
      "EncryptChain": [
        "null\n"
      ],
      "Key": "null",
      "Chain": [
        "-----BEGIN CERTIFICATE----- MIID……l+o= -----END CERTIFICATE-----"
      ]
    },
    "NotAfter": 1681401599,
    "NotBefore": 1678778206,
    "CreateAt": "1678778206",
    "InstanceStatus": 1,
    "Duration": "30天",
    "SourceType": 0,
    "Plan": "Standard",
    "ProjectName": "default",
    "Tags": [
      {
        "Key": "env",
        "Value": "test"
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
200	MalformedRequest	The request is malformed	请求参数格式不合法。
200	InternalError	The request has failed due to an unknown error.	未知错误。

最近更新时间：2026.01.07 17:39:53

这个页面对您有帮助吗？

有用

无用

证书中心

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求说明

调试

请求参数

返回参数

请求示例

返回示例

错误码