文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ CA证书管理/ 更新CA证书 - UpdateCertificate
更新时间：2025-12-02 GMT+08:00
查看PDF
分享

更新CA证书 - UpdateCertificate

功能介绍

应用服务器可调用此接口在物联网平台上更新CA证书。仅标准版实例、企业版实例支持该接口调用，基础版不支持。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    iotda:certificates:update

    Write

    app *

    -

    -

    -

    -

    g:EnterpriseProjectId

URI

PUT /v5/iot/{project_id}/certificates/{certificate_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见 获取项目ID。

certificate_id

是

String

CA证书ID，在上传CA证书时由平台分配的唯一标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

否

String

实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。
表3 请求Body参数

参数

是否必选

参数类型

描述

provision_enable

否

Boolean

是否开启自注册能力，当为true时该功能必须配合预调配功能使用，true：是，false：否。

template_id

否

String

预调配模板ID，该CA证书绑定的预调配模板id，当该字段传null时表示解除绑定关系。

ocsp_enable

否

Boolean

是否开启该CA证书下的设备证书OCSP校验，当为true且设备证书信息中包含OCSP url时则平台会校验证书的状态，当证书状态为revoked时平台会拒绝设备连接，true：开启，false：关闭。

ocsp_ssl_enable

否

Boolean

访问ocsp服务器是否开启SSL，开启后必须配置服务器CA证书校验。

ocsp_server_ca_id

否

String

ocsp服务器端CA证书id，当ocsp服务器为https协议时需要配置，否则认证失败。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

certificate_id

String

CA证书ID，在上传CA证书时由平台分配的唯一标识。

cn_name

String

CA证书CN名称。

owner

String

CA证书所有者。

status

Boolean

CA证书验证状态。true代表证书已通过验证，可进行设备证书认证接入。false代表证书未通过验证。

verify_code

String

CA证书验证码。

provision_enable

Boolean

是否开启自注册能力，当为true时该功能必须配合预调配功能使用，true：是，false：否。

template_id

String

绑定的预调配模板ID。

ocsp_enable

Boolean

是否开启该CA证书下的设备证书OCSP校验，当为true且设备证书信息中包含OCSP url时则平台会校验证书的状态，当证书状态为revoked时平台会拒绝设备连接，true：开启，false：关闭。

ocsp_server_ca_id

String

ocsp服务器端CA证书id，仅当ocsp服务器开启SSL时配置，平台使用该CA证书认证ocsp服务器。

ocsp_ssl_enable

Boolean

ocsp服务器是否开启SSL加密，开启后必须配置OCSP服务器CA证书。

create_date

String

创建证书日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

effective_date

String

CA证书生效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

expiry_date

String

CA证书失效日期。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

请求示例

证书关联自注册模板，并开启自注册功能。

PUT https://{endpoint}/v5/iot/{project_id}/certificates/{certificate_id}

{
  "template_id" : "61c970ce2d63eb6ee655dbf0",
  "provision_enable" : true
}

响应示例

状态码：200

Successful response

{
  "certificate_id" : "string",
  "cn_name" : "string",
  "owner" : "string",
  "status" : true,
  "verify_code" : "string",
  "provision_enable" : true,
  "template_id" : "61c970ce2d63eb6ee655dbf0",
  "create_date" : "20191212T121212Z",
  "effective_date" : "20191212T121212Z",
  "expiry_date" : "20221212T121212Z",
  "ocsp_enable" : "false,",
  "ocsp_server_ca_id" : "60fa667369d4840337930aec",
  "ocsp_ssl_enable" : true
}

状态码

状态码

描述

200

Successful response

400

Bad Request

401

Unauthorized

404

Not Found

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： CA证书管理