文档首页/设备接入 IoTDA/API参考/应用侧API参考/API/域配置管理/更新域配置 - UpdateDomainConfiguration
更新时间：2025-12-18 GMT+08:00
查看PDF
分享

更新域配置 - UpdateDomainConfiguration

功能介绍

应用服务器可调用此接口在物联网平台上更新域配置。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    iotda:domainconfiguration:update

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

PUT /v5/iot/{project_id}/domain-configurations/{configuration_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数说明：项目ID。获取方法请参见 获取项目ID。

configuration_id

是

String

参数说明：域配置ID，由平台分配的唯一标识。

取值范围：长度不超过24，只允许字母、数字、下划线（_）、连接符（-）的组合。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

否

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

server_certificate_id

否

String

参数说明：自定义服务端证书ID。

取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。

server_certificate_config

否

ServerCertificateConfig object

参数说明：服务端证书配置。

表4 ServerCertificateConfig

参数

是否必选

参数类型

描述

ocsp_stapling_enable

否

Boolean

参数说明：是否开启服务端OCSP装订。

取值范围：true：开启OCSP装订，false：关闭OCSP装订，默认为false。

ocsp_server_ca_id

否

String

参数说明：ocsp服务器端CA证书id，仅当ocsp服务器为https协议时支持配置。

取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。

ocsp_ssl_enable

否

Boolean

参数说明：访问ocsp服务器是否开启SSL。

取值范围：true：开启SSL，false：关闭SSL，默认为true。

响应参数

状态码：201

表5 响应Body参数

参数

参数类型

描述

configuration_id

String

域配置唯一标识ID

domain_name

String

参数说明：自定义域名

access_protocol

String

参数说明：应用协议场景，当前仅支持Device-MQTTS：设备接入MQTTS场景

server_certificate_id

String

参数说明：自定义服务端证书ID

server_certificate_config

ServerCertificateConfig object

参数说明：服务端证书配置。

表6 ServerCertificateConfig

参数

参数类型

描述

ocsp_stapling_enable

Boolean

参数说明：是否开启服务端OCSP装订。

取值范围：true：开启OCSP装订，false：关闭OCSP装订，默认为false。

ocsp_server_ca_id

String

参数说明：ocsp服务器端CA证书id，仅当ocsp服务器为https协议时支持配置。

取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。

ocsp_ssl_enable

Boolean

参数说明：访问ocsp服务器是否开启SSL。

取值范围：true：开启SSL，false：关闭SSL，默认为true。

请求示例

更新域配置

PUT https://{endpoint}/v5/iot/{project_id}/domain-configurations/{configuration_id}

{
  "server_certificate_id" : "5c90fa7d3c4e4405e8525079",
  "server_certificate_config" : {
    "ocsp_stapling_enable" : false,
    "ocsp_ssl_enable" : false
  }
}

响应示例

状态码：201

Created

{
  "configuration_id" : "5c90fa7d3c4e4405e8525079",
  "domain_name" : "iotda-device.cn-north-4.myhuaweicloud.com",
  "access_protocol" : "Device-MQTTS",
  "server_certificate_id" : "5c90fa7d3c4e4405e8525079",
  "server_certificate_config" : {
    "ocsp_stapling_enable" : false,
    "ocsp_server_ca_id" : "5c90fa7d3c4e4405e8525079",
    "ocsp_ssl_enable" : true
  }
}

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题：域配置管理