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

证书中心

复制全文
下载 pdf
私有根CA
ListRootInstances - 查询私有根CA列表
复制全文
下载 pdf
ListRootInstances - 查询私有根CA列表
调用本接口查询已创建的私有根CA(以下简称“根CA”)实例的列表。​
请求说明​
  • 接口名称:ListRootInstances​
  • 请求方式:POST​
  • 请求地址:​
  • IPv4网络接入:pca.volcengineapi.com​
  • 双栈网络接入(IPv4/IPv6):pca.volcengine-api.com​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Query​
Action string 必选 示例值:ListRootInstances​
要执行的操作,取值:ListRootInstances。​
​
Version string 必选 示例值:2025-10-01​
API的版本,取值:2025-10-01。​
​
​
​
Body​
CommonName string 可选 示例值:Volcengine CA​
指定一个公用名(CN)(对应证书中的CN字段)对根CA证书进行筛选。​
​
SourceType integer 可选 示例值:0​
指定一个来源类型对根CA证书进行筛选。该参数有以下取值:​
  • 0:在证书中心创建​
  • 1:上传到证书中心​
​
InstanceStatus string 可选 示例值:1​
指定一个实例状态对根CA证书进行筛选。该参数有以下取值:​
  • 0:未知​
  • 1:已启用​
  • 2:已停用​
  • 4:已吊销​
  • 8:已冻结(实例欠费)​
  • 16:已过期​
​
PageNumber integer 可选 示例值:1​
请求的页码,取值范围:>= 1。默认值:1。​
​
PageSize integer 可选 示例值:1​
查询结果中每页的根CA数量。取值范围:1~20。​
​
TagFilters object[] 可选 示例值:-​
标签筛选器。查询关联指定标签的资源。​
Key string 必选 示例值:env​
资源标签键。​
​
Values string[] 可选 示例值:["production", "staging"] ["devops-team"]​
资源标签值列表,表示该 Key 下允许匹配的一个或多个值。​
​
​
InstanceId string 可选 示例值:pca_root_aXPEF****​
指定一个实例ID对根CA证书进行筛选。​
​
ProjectName string 可选 示例值:default​
指定根CA所属的项目。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Count integer 示例值:1​
符合查询条件的根CA证书的数量。​
​
PageNumber integer 示例值:1​
返回的页码。​
​
PageSize integer 示例值:1​
查询结果中每页的根CA数量。取值范围:1~20。​
​
Result object[] 示例值:-​
根CA实例列表。​
CommonName string 示例值:Volcengine CA​
根CA证书的公用名(CN)。​
​
InstanceId string 示例值:pca_root_aXPEF****​
根CA证书的实例ID。​
​
IssuedId string 示例值:null​
证书签发者的实例ID。对于根CA证书,该参数的值为空。​
​
IssuedCommonName string 示例值:null​
证书签发者的公用名(CN)。对于根CA证书,该参数的值为空。​
​
InstanceStatus integer 示例值:1​
实例的状态。该参数有以下取值:​
  • 0:未知​
  • 1:已启用​
  • 2:已停用​
  • 4:已吊销​
  • 8:已冻结(实例欠费)​
  • 16:已过期​
​
SerialNumber string 示例值:331D4CD014E4813AB8302E47DD9EB436DE2E7BDE​
证书序列号。​
​
SignatureAlgorithm string 示例值:SHA512-RSA​
根CA证书的签名算法。​
​
Tag string 示例值:doc-test-RootCA​
根CA证书的备注。​
​
Contact object 示例值:-​
根CA证书的联系人信息。​
Name string 示例值:张三​
联系人姓名。​
​
Email string 示例值:zhangsan@example.com​
联系人邮箱。​
​
PhoneNumber string 示例值:131****1111​
联系人电话。​
​
​
Subject object 示例值:-​
根CA证书的主题信息。​
Country string[] 示例值:CN​
国家(C)。​
​
Organization string[] 示例值:Volcengine​
企业名称(O)。​
​
OrganizationalUnit string[] 示例值:ti​
部门(OU)。​
​
Locality string[] 示例值:海淀​
城市(L)。​
​
Province string[] 示例值:北京​
省份(ST)。​
​
StreetAddress string[] 示例值:某某路某某号​
街道。​
​
PostalCode string[] 示例值:100080​
邮编(PostalCode)。​
​
SerialNumber string 示例值:331D4CD014E4813AB8302E47DD9EB436DE2E7BDE​
证书序列号。​
​
CommonName string 示例值:公用名(CN)。​
公用名(CN)。​
​
​
EncryptionAlgorithm string 示例值:RSA-4096​
根CA证书的密钥算法。​
​
Duration string 示例值:30天​
根CA实例的购买时长。​
​
SourceType integer 示例值:0​
指定一个来源类型对根CA证书进行筛选。该参数有以下取值:​
  • 0:在证书中心创建​
  • 1:上传到证书中心​
​
Plan string 示例值:basic​
根CA证书的规格。​
​
HasPrivateKey boolean 示例值:true​
平台是否托管了私钥。​
​
Tags object[] 示例值:-​
根CA证书的标签。​
Key string 示例值:env​
资源标签键。​
​
Value string 示例值:test​
资源标签值。​
​
​
ProjectName string 示例值:default​
根CA证书所属的项目组。​
​
DeployInfo object 示例值:-​
根CA证书关联云资源数据。​
DeploySummary object[] 示例值:{ "ServiceName": "CDN", "ResourceCount": "5" }​
部署信息汇总。​
ServiceName string 示例值:CDN​
资源绑定的云服务名称。​
​
ResourceCount integer 示例值:5​
绑定的资源数量。​
​
​
​
CreateAt string 示例值:1678778206​
根CA证书实例的创建时间。使用秒级时间戳表示。​
​
NotAfter integer 示例值:1681401599​
根CA证书过期的时间。使用秒级时间戳表示。​
​
NotBefore integer 示例值:1678778206​
根CA证书开始生效的时间。使用秒级时间戳表示。​
​
​
​
​
请求示例​
​
POST /?Action=ListRootInstances&Version=2025-10-01 HTTP/1.1​
Host: pca.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260805T111835Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260805/cn-beijing/pca/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"SourceType": 0,​
"InstanceStatus": "1",​
"PageNumber": 1,​
"PageSize": 10,​
"TagFilters": [​
{​
"Key": "env",​
"Values": [​
"production"​
]​
}​
]​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260805191847095201175168189588",​
"Action": "ListRootInstances",​
"Version": "2025-10-01",​
"Service": "pca",​
"Region": "cn-beijing"​
},​
"Result": {​
"Count": 1,​
"PageNumber": 1,​
"PageSize": 1,​
"Result": [​
{​
"CommonName": "Volcengine CA",​
"InstanceId": "pca_root_aXPEF****",​
"IssuedId": "null",​
"IssuedCommonName": "null",​
"InstanceStatus": 1,​
"SerialNumber": "331D4CD014E4813AB8302E47DD9EB436DE2E7BDE",​
"SignatureAlgorithm": "SHA512-RSA",​
"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": "公用名(CN)。"​
},​
"EncryptionAlgorithm": "RSA-4096",​
"Duration": "30天",​
"SourceType": 0,​
"Plan": "basic",​
"HasPrivateKey": true,​
"Tags": [​
{​
"Key": "env",​
"Value": "test"​
}​
],​
"ProjectName": "default",​
"DeployInfo": {​
"DeploySummary": [​
{​
"ServiceName": "CDN",​
"ResourceCount": 5​
}​
]​
},​
"CreateAt": "1678778206",​
"NotAfter": 1681401599,​
"NotBefore": 1678778206​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
200​
InternalError​
The request has failed due to an unknown error.​
未知错误。请记录响应中的 RequestId、接口名称、调用时间和完整错误信息,提交工单联系技术支持。​
200​
MalformedRequest​
The request is malformed​
请求参数格式不合法。请检查请求参数的位置、编码和格式,并按本文参数说明修正请求。​
​
​
最近更新时间:2026.10.27 17:49:05
这个页面对您有帮助吗?
有用
有用
无用
无用