添加域配置
功能介绍
应用服务器可调用此接口在物联网平台上添加域配置，域配置配额上限为：1个。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v5/iot/{project_id}/domain-configurations
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
domain_name |
是 |
String |
参数说明：自定义域名。 取值范围：合法域名格式，需满足正则表达式：[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+\.?。 |
|
access_protocol |
是 |
String |
参数说明：接入协议，当前仅支持Device-MQTTS：设备接入MQTTS场景。 取值范围：目前仅支持：Device-MQTTS。 |
|
server_certificate_id |
是 |
String |
参数说明：自定义服务器证书ID。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
|
server_certificate_config |
否 |
ServerCertificateConfig object |
参数说明：服务端证书配置。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
configuration_id |
String |
域配置唯一标识ID |
|
domain_name |
String |
参数说明：自定义域名 |
|
access_protocol |
String |
参数说明：应用协议场景，当前仅支持Device-MQTTS：设备接入MQTTS场景 |
|
server_certificate_id |
String |
参数说明：自定义服务端证书ID |
|
server_certificate_config |
ServerCertificateConfig object |
参数说明：服务端证书配置。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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。 |
请求示例
添加域配置
POST https://{endpoint}/v5/iot/{project_id}/domain-configurations
{
"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
{
"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 |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
错误码
请参见错误码。
