文档首页/ 云防火墙 CFW/ API参考/ API/ TLS证书管理/ 获取TLS证书
更新时间：2025-08-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取TLS证书

功能介绍

获取TLS证书

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/certificate

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。项目ID获取方式

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

是

String

参数解释：

防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过防火墙ID获取方式获取

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

data

ListTlsCertificateRespData object

参数解释：

获取TLS证书响应DATA

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表4 ListTlsCertificateRespData

参数

参数类型

描述

name

String

参数解释：

证书名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

key

String

参数解释：

证书密钥

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

certificate_info_s

Array of CertificateInfo objects

参数解释：

证书信息

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表5 CertificateInfo

参数

参数类型

描述

issuing_unit

IssuingUnit object

参数解释：

证书发布单位

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

validity_period

ValidityPeriod object

参数解释：

有效期信息

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表6 IssuingUnit

参数

参数类型

描述

common_name

String

参数解释：

名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

organization

String

参数解释：

组织

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

organization_unit

String

参数解释：

组织单位

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表7 ValidityPeriod

参数

参数类型

描述

issuing_date

Long

参数解释：

颁发日期

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

expiration_date

Long

参数解释：

有效日期

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

取值范围：

不涉及

error_msg

String

参数解释：

错误描述

取值范围：

不涉及

请求示例

查询项目ID为5de88e3e18124fa99675fb51ceceaa31,防火墙ID为ef053720-decd-4205-a923-91785d627203的证书列表

https://{Endpoint}/v1/5de88e3e18124fa99675fb51ceceaa31/certificate?fw_instance_id=ef053720-decd-4205-a923-91785d627203

响应示例

状态码：200

OK

{
  "data" : {
    "name" : "AV-CERT",
    "key" : "Ga**a@11**",
    "certificate_info_s" : [ {
      "issuing_unit" : {
        "common_name" : "192.168.1.100"
      },
      "validity_period" : {
        "issuing_date" : 1751133252000,
        "expiration_date" : 1782669252000
      }
    } ]
  }
}

状态码：400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： TLS证书管理

相关文档