GetSubInstance - 查询私有子CA实例详情--证书中心-火山引擎

文档中心

证书中心

私有子CA

GetSubInstance - 查询私有子CA实例详情

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

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

返回参数

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

参数	类型	示例值	描述
InstanceId	String	pca_sub_MlRaK****	子CA实例的ID。
RootCaId	String	pca_root_aXPEF****	对应的根CA实例的ID。
EncryptionAlgorithm	String	RSA 2048	子CA证书的密钥算法。
SignatureAlgorithm	String	SHA512-RSA	子CA证书的签名算法。
SerialNumber	String	54E27CD911DC45EB0F026B1B9A5ABE0F9E0B7474	子CA证书的序列号。
Tag	String	doc-test-SubCA	子CA证书的备注。
Subject	Object	-	子CA证书的来源。该参数有以下取值： 0：在证书中心创建 1：上传到证书中心
Contact	Object	-	子CA证书的联系人信息。
CommonName	String	Certificate Center CA	子CA证书的公用名。
Certificate	Object	-	子CA证书的内容。
CreateAt	String	1678791085	子CA证书实例的创建时间。使用秒级时间戳表示。
InstanceStatus	Integer	1	实例的状态。该参数有以下取值： 0：未知 1：正常运行 2：已停用 4：已吊销 8：已冻结（实例欠费） 16：已过期
Duration	String	20天	子CA实例的购买时长。
Plan	String	Standard	子CA证书规格。
SourceType	Integer	0	子CA证书的来源。该参数有以下取值： 0：在证书中心创建 1：上传到证书中心
Tags	Array of Object	-	子CA证书绑定的标签。
ProjectName	String	default	子CA证书归属的项目组。
NotAfter	Integer	1681401599	子CA证书过期的时间。使用秒级时间戳表示。
NotBefore	Integer	1678778206	子CA证书开始生效的时间。使用秒级时间戳表示。

请求示例

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

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202510291439481121680170219BBFB8",
    "Action": "GetSubInstance",
    "Version": "2025-10-01",
    "Service": "pca",
    "Region": "cn-beijing"
  },
  "Result": {
    "InstanceId": "lR",
    "RootCaId": "rm",
    "EncryptionAlgorithm": "YGwUv",
    "SignatureAlgorithm": "iAk2NVZxV",
    "SerialNumber": "RTF3q",
    "Tag": "2",
    "Subject": {
      "Country": [
        "CN"
      ],
      "Organization": [
        "Volcano\n"
      ],
      "OrganizationalUnit": [
        "ti"
      ],
      "Locality": [
        "北京"
      ],
      "Province": [
        "Z3"
      ],
      "StreetAddress": [
        "i3"
      ],
      "PostalCode": [
        "kjqIOh9i"
      ],
      "SerialNumber": "sHmG6Qd9c0r",
      "CommonName": "XGlPZHhSL72"
    },
    "Contact": {
      "Name": "mVoQa1S",
      "Email": "rO",
      "PhoneNumber": "s09Vs7i1V"
    },
    "CommonName": "PTBC",
    "Certificate": {
      "Csr": "1j0iv",
      "EncryptKey": "8dGA5eKJGr",
      "EncryptChain": [
        "IDlB2rj9"
      ],
      "Key": "f0N",
      "Chain": [
        "N"
      ]
    },
    "CreateAt": "9",
    "InstanceStatus": 0,
    "Duration": "RwGR4syjuJz",
    "Plan": "JdAwt",
    "SourceType": 787,
    "Tags": [
      {
        "Key": "7nbk9",
        "Value": "zLx8o3pzROZ"
      }
    ],
    "ProjectName": "6XnWsP0ZYSH",
    "NotAfter": 927,
    "NotBefore": 65
  }
}

错误码

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

状态码	错误码	错误信息	说明
200	InternalError	The request has failed due to an unknown error.	未知错误。
200	MissingParameter	The required parameter %s is missing.	缺少必填参数。

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

这个页面对您有帮助吗？

有用

无用

证书中心

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求说明

调试

请求参数

返回参数

请求示例

返回示例

错误码