更新时间:2025-11-27 GMT+08:00
分享

添加域配置

功能介绍

应用服务器可调用此接口在物联网平台上添加域配置,域配置配额上限为:1个。

调用方法

请参见如何调用API

URI

POST /v5/iot/{project_id}/domain-configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Instance-Id

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

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

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

表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。

请求示例

添加域配置

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
  }
}

SDK代码示例

SDK代码示例如下。

添加域配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.AbstractCredentials;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.core.region.Region;
import com.huaweicloud.sdk.iotda.v5.*;
import com.huaweicloud.sdk.iotda.v5.model.*;


public class CreateDomainConfigurationSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        // ENDPOINT:请在控制台的"总览"界面的"平台接入地址"中查看“应用侧”的https接入地址。
        String iotdaEndpoint = "<YOUR ENDPOINT>";
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                // 标准版/企业版需要使用衍生算法,基础版请删除配置"withDerivedPredicate";
                .withDerivedPredicate(AbstractCredentials.DEFAULT_DERIVED_PREDICATE) // Used in derivative ak/sk authentication scenarios
                .withAk(ak)
                .withSk(sk);

        IoTDAClient client = IoTDAClient.newBuilder()
                .withCredential(auth)
                // 标准版/企业版:需自行创建Region对象,基础版:请使用IoTDARegion的region对象,如"withRegion(IoTDARegion.CN_NORTH_4)"
                .withRegion(new Region("cn-north-4", iotdaEndpoint))
                .build();
        CreateDomainConfigurationRequest request = new CreateDomainConfigurationRequest();
        CreateDomainConfigurationDTO body = new CreateDomainConfigurationDTO();
        ServerCertificateConfig serverCertificateConfigbody = new ServerCertificateConfig();
        serverCertificateConfigbody.withOcspStaplingEnable(false)
            .withOcspServerCaId("5c90fa7d3c4e4405e8525079")
            .withOcspSslEnable(true);
        body.withServerCertificateConfig(serverCertificateConfigbody);
        body.withServerCertificateId("5c90fa7d3c4e4405e8525079");
        body.withAccessProtocol("Device-MQTTS");
        body.withDomainName("iotda-device.cn-north-4.myhuaweicloud.com");
        request.withBody(body);
        try {
            CreateDomainConfigurationResponse response = client.createDomainConfiguration(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

添加域配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcore.auth.credentials import DerivedCredentials
from huaweicloudsdkcore.region.region import Region as coreRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkiotda.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    # ENDPOINT:请在控制台的"总览"界面的"平台接入地址"中查看“应用侧”的https接入地址,下面创建Client时需要使用自行创建的Region对象,基础版:请选择IoTDAClient中的Region对象 如: IoTDAClient.new_builder().with_region(IoTDARegion.CN_NORTH_4)
    endpoint = "<YOUR ENDPOINT>";
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId).with_derived_predicate(DerivedCredentials.get_default_derived_predicate())

    client = IoTDAClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(coreRegion(id="cn-north-4", endpoint=endpoint)) \
        .build()

    try:
        request = CreateDomainConfigurationRequest()
        serverCertificateConfigbody = ServerCertificateConfig(
            ocsp_stapling_enable=False,
            ocsp_server_ca_id="5c90fa7d3c4e4405e8525079",
            ocsp_ssl_enable=True
        )
        request.body = CreateDomainConfigurationDTO(
            server_certificate_config=serverCertificateConfigbody,
            server_certificate_id="5c90fa7d3c4e4405e8525079",
            access_protocol="Device-MQTTS",
            domain_name="iotda-device.cn-north-4.myhuaweicloud.com"
        )
        response = client.create_domain_configuration(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

添加域配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    iotda "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iotda/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/region"
    core_auth "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    // endpoint:请在控制台的"总览"界面的"平台接入地址"中查看"应用侧"的https接入地址
    endpoint := "<YOUR ENDPOINT>"
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        // 企业版/标准版需要使用衍生算法,基础版请删除该配置"WithDerivedPredicate"
        WithDerivedPredicate(core_auth.GetDefaultDerivedPredicate()). // Used in derivative ak/sk authentication scenarios
        Build()

    client := iotda.NewIoTDAClient(
        iotda.IoTDAClientBuilder().
            // 标准版/企业版需要自行创建region,基础版使用IoTDARegion中的region对象
            WithRegion(region.NewRegion("cn-north-4", endpoint)).
            WithCredential(auth).
            Build())

    request := &model.CreateDomainConfigurationRequest{}
	ocspStaplingEnableServerCertificateConfig:= false
	ocspServerCaIdServerCertificateConfig:= "5c90fa7d3c4e4405e8525079"
	ocspSslEnableServerCertificateConfig:= true
	serverCertificateConfigbody := &model.ServerCertificateConfig{
		OcspStaplingEnable: &ocspStaplingEnableServerCertificateConfig,
		OcspServerCaId: &ocspServerCaIdServerCertificateConfig,
		OcspSslEnable: &ocspSslEnableServerCertificateConfig,
	}
	request.Body = &model.CreateDomainConfigurationDto{
		ServerCertificateConfig: serverCertificateConfigbody,
		ServerCertificateId: "5c90fa7d3c4e4405e8525079",
		AccessProtocol: "Device-MQTTS",
		DomainName: "iotda-device.cn-north-4.myhuaweicloud.com",
	}
	response, err := client.CreateDomainConfiguration(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

Created

401

Unauthorized

403

Forbidden

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档