编辑证书

编辑 PBX 服务器证书。

请求 URL

POST {base_url}/{api_path}/certificate/update?access_token={access_token}

请求参数

参数 是否必填 类型 说明
id 是 Integer 证书 ID。
注： 可通过 查询证书列表 查询证书 ID。
name 否 String 证书文件名。
注： 如需替换当前证书，你需要先上传证书到 PBX，然后从响应中的 file 字段获取证书文件名。
issue_to 否 String 证书要关联的域名。
注： 此参数仅在编辑申请的证书时生效 (ca_type=apply)。
auto_renewal 否 Integer 是否为证书启用自动刷新。
取值范围：
  • 0：禁用。
  • 1：启用。
注： 该参数仅对导入的证书生效 (ca_type=upload)。
dns_provider 否 String 用于证书申请或自动刷新的 DNS 提供商。
注：
  • 此参数在以下场景中必填：
    • auto_renewal 设为 1。
    • type 为 server 且 ca_type 为 apply.
  • 关于具体的参数值，请参见 支持的 DNS 提供商 中的 标识名称 栏。
auth_info_list 否 Array<Auth_Info> 证书申请和自动刷新所需的 DNS 验证信息。
注： 此参数在以下场景中必填：
  • auto_renewal 设为 1。
  • type 为 server 且 ca_type 为 apply.
Auth_Info
注：
  • 你必须提供 DNS 提供商所要求的整套参数，否则会导致请求失败。
  • 关于各 DNS 提供商所需的验证参数及其值的类型，请参见 支持的 DNS 提供商。
参数 是否必填 类型 说明
k 是 String DNS 提供商定义的验证参数键名。
iv 否 Integer 整型格式的验证参数值。
sv 否 String 字符串格式的验证参数值。
bv 否 Boolean 布尔型格式的验证参数值。

响应参数

表 1.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

禁用某个导入证书 (id: 5) 的自动刷新功能。

POST /openapi/v1.0/certificate/update?access_token=wOODrqhysk0aELacF87qd4lBvmbBY4IZ HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "id":5, 
    "auto_renewal": 0
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}