ListSubInstances - 查询私有子CA实例列表--证书中心-火山引擎

文档中心

立即注册

证书中心

私有子CA

ListSubInstances - 查询私有子CA实例列表

调用本接口获取已创建的私有子CA（以下简称“子CA”）实例的列表。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	ListSubInstances	要执行的操作，取值：ListSubInstances。
Version	String	是	2025-10-01	API的版本，取值：2025-10-01。

Body

参数	类型	是否必填	示例值	描述
CommonName	String	否	Certificate Center CA	指定一个公用名（对应证书中的CN字段）对子CA证书进行筛选。
SourceType	Integer	否	0	指定一个来源类型对子CA证书进行筛选。该参数有以下取值： 0：在证书中心创建 1：上传到证书中心
InstanceStatus	String	否	1	指定一个实例状态对子CA证书进行筛选。该参数有以下取值： 0：未知 1：正常运行 2：已停用 4：已吊销 8：已冻结（实例欠费） 16：已过期
PageNumber	Integer	否	1	请求的页码。
PageSize	Integer	否	1	查询结果中每页的子CA数量。取值范围：1~20。
TagFilters	Array of Object	否	-	指定子CA实例绑定的标签。
InstanceId	String	否	pca_sub_MlRaK****	指定一个实例ID对子CA证书进行筛选。
ProjectName	String	否	default	指定子CA实例所属的项目。
IssuedId	String	否	pca_root_aXPEF****	指定上一级CA实例（根CA实例）的ID对子CA证书进行筛选。

返回参数

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

参数	类型	示例值	描述
PageNumber	Integer	1	返回的页码。
PageSize	Integer	1	查询结果中每页的子CA数量。
Count	Integer	1	符合查询条件的子CA实例的数量。
Result	Array of Object	-	子CA实例列表。

请求示例

POST /?Action=ListSubInstances&Version=2025-10-01 HTTP/1.1
Host: pca.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251030T055335Z
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

{
  "CommonName": "Certificate Center CA",
  "SourceType": 0,
  "InstanceStatus": "1",
  "PageNumber": 1,
  "PageSize": 1,
  "TagFilters": [
    {
      "Key": "env",
      "Values": [
        "[\"production\", \"staging\"]\n[\"devops-team\"]"
      ]
    }
  ],
  "InstanceId": "pca_sub_MlRaK****",
  "ProjectName": "default",
  "IssuedId": "pca_root_aXPEF****"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025103013533901819315514764EDA3",
    "Action": "ListSubInstances",
    "Version": "2025-10-01",
    "Service": "pca",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 1,
    "Count": 1,
    "Result": [
      {
        "IssuedId": "pca_root_aXPEF****",
        "IssuedCommonName": "Volcengine CA",
        "InstanceId": "pca_sub_MlRaK****",
        "InstanceStatus": 1,
        "CommonName": "Certificate Center CA",
        "Tag": "doc-test-SubCA",
        "EncryptionAlgorithm": "RSA 2048",
        "Subject": {
          "Country": [
            "CN"
          ],
          "Organization": [
            "Volcengine"
          ],
          "OrganizationalUnit": [
            "ti"
          ],
          "Locality": [
            "海淀"
          ],
          "Province": [
            "北京"
          ],
          "StreetAddress": [
            "某某路某某号"
          ],
          "PostalCode": [
            "100080"
          ],
          "SerialNumber": "331D4CD014E4813AB8302E47DD9EB436DE2E7BDE",
          "CommonName": "Volcengine CA"
        },
        "SignatureAlgorithm": "SHA256-RSA",
        "Plan": "basic",
        "SourceType": 0,
        "Duration": "20天",
        "SerialNumber": "331D4CD014E4813AB8302E47DD9EB436DE2E7BDE",
        "NotAfter": 1681401599,
        "NotBefore": 1678778206,
        "CreateAt": "1678778206",
        "Contact": {
          "Name": "张三",
          "Email": "zhangsan@example.com",
          "PhoneNumber": "131****1111"
        },
        "HasPrivateKey": true,
        "Tags": [
          {
            "Key": "env",
            "Value": "test"
          }
        ],
        "ProjectName": "default",
        "DeployInfo": {
          "DeploySummary": [
            {
              "ServiceName": "CDN",
              "ResourceCount": 1
            }
          ]
        }
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
200	MalformedRequest	The request is malformed	请求参数格式不合法。
200	MissingParameter	The required parameter %s is missing.	缺少必填参数。
200	InvalidParameter	The specified parameter %s is invalid.	指定的参数值无效。

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

这个页面对您有帮助吗？

有用

无用

证书中心

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #