文档首页/ 设备接入 IoTDA/ API参考/ 应用侧API参考/ API/ 预调配模板管理/ 创建预调配模板
更新时间：2024-10-23 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建预调配模板

功能介绍

应用服务器可调用此接口在物联网平台创建一个预调配模板。用户的设备未在平台注册时，可以通过预调配模板在设备首次接入物联网平台时将设备信息自动注册到物联网平台。

  • 该预调配模板至少需要绑定到一个设备CA证书下才能生效。

  • 一个实例最多可有10个预调配模板。

  • 仅标准版实例、企业版实例支持该接口调用，基础版不支持。

调用方法

请参见如何调用API。

URI

POST /v5/iot/{project_id}/provisioning-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数说明：用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

Instance-Id

否

String

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

参数

是否必选

参数类型

描述

template_name

是

String

参数说明：预调配模板名称。

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

description

否

String

参数说明：预调配模板的描述信息。

取值范围：长度不超过2048，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合

template_body

是

ProvisioningTemplateBody object

参数说明：预调配模板详细内容，json格式。
表4 ProvisioningTemplateBody

参数

是否必选

参数类型

描述

parameters

是

Object

参数说明：预调配模板参数， ，配置格式为{"parameter":{"type":"String"}} ，其中parameter目前支持从预调配设备的证书的使用者字段提取内容，证书必须包含模板中定义的所有参数值，华为云IoT平台定义了可在预调配模板中声明和引用的如下参数:

  • iotda::certificate::country (国家/地区,C )

  • iotda::certificate::organization (组织,O)

  • iotda::certificate::organizational_unit (组织单位,OU)

  • iotda::certificate::distinguished_name_qualifier (可辨别名称限定符,dnQualifier)

  • iotda::certificate::state_name (省市,ST)

  • iotda::certificate::common_name (公用名,CN)

  • iotda::certificate::serial_number (序列号,serialNumber)

type描述parameter的类型，目前仅支持string。

配置样例：

'{"iotda::certificate::country":{"type":"String"},

"iotda::certificate::organization":{"type":"String"},

"iotda::certificate::organizational_unit":{"type":"String"},

"iotda::certificate::distinguished_name_qualifier":{"type":"String"},

"iotda::certificate::state_name":{"type":"String"},

"iotda::certificate::common_name":{"type":"String"},

"iotda::certificate::serial_number":{"type":"String"}}'

resources

是

TemplateResource object

预调配模板设备资源结构体。
表5 TemplateResource

参数

是否必选

参数类型

描述

device

是

DeviceResource object

预调配模板设备资源详情结构体。

policy

否

PolicyResource object

预调配模板设备策略资源详情结构体。
表6 DeviceResource

参数

是否必选

参数类型

描述

device_name

否

ParameterRef object

设备名称

node_id

是

ParameterRef object

设备标识码

product_id

是

Object

参数说明：设备所属的产品id，可以是一个明确的静态字符串id，也可以是动态的模板参数引用

  • 明确的静态字符串："642bf260f2f9030e44210d8d"。取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。"

  • 参数引用: {"ref" : "iotda::certificate::country"}

tags

否

Array of TagRef objects

参数说明：设备绑定的标签列表
表7 ParameterRef

参数

是否必选

参数类型

描述

ref

是

String

参数引用名称
表8 TagRef

参数

是否必选

参数类型

描述

tag_key

否

Object

参数说明：标签键名称，可以是一个明确的静态字符串，也可以是动态的模板参数引用

  • 明确的静态字符串："myTagKey"。取值范围：长度不超过64，只允许中文、字母、数字、以及_.-等字符的组合

  • 参数引用: {"ref" : "iotda::certificate::country"}

tag_value

否

Object

参数说明：标签值，可以是一个明确的静态字符串，也可以是动态的模板参数引用

  • 明确的静态字符串："myTagValue"。取值范围：长度不超过128，只允许中文、字母、数字、以及_.-等字符的组合。

  • 参数引用: {"ref" : "iotda::certificate::country"}
表9 PolicyResource

参数

是否必选

参数类型

描述

policy_ids

否

Array of strings

参数说明：设备需要绑定的策略id列表

响应参数

状态码： 201

表10 响应Body参数

参数

参数类型

描述

template_id

String

参数说明：预调配模板ID。

template_name

String

参数说明：预调配模板名称。

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

description

String

参数说明：预调配模板的描述信息。

取值范围：长度不超过2048，只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合

template_body

ProvisioningTemplateBody object

参数说明：预调配模板详细内容，json格式。

create_time

String

在物联网平台创建预调配模板的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。

update_time

String

在物联网平台更新预调配模板的时间。格式：yyyyMMdd'T'HHmmss'Z'，如20151212T121212Z。
表11 ProvisioningTemplateBody

参数

参数类型

描述

parameters

Object

参数说明：预调配模板参数， ，配置格式为{"parameter":{"type":"String"}} ，其中parameter目前支持从预调配设备的证书的使用者字段提取内容，证书必须包含模板中定义的所有参数值，华为云IoT平台定义了可在预调配模板中声明和引用的如下参数:

  • iotda::certificate::country (国家/地区,C )

  • iotda::certificate::organization (组织,O)

  • iotda::certificate::organizational_unit (组织单位,OU)

  • iotda::certificate::distinguished_name_qualifier (可辨别名称限定符,dnQualifier)

  • iotda::certificate::state_name (省市,ST)

  • iotda::certificate::common_name (公用名,CN)

  • iotda::certificate::serial_number (序列号,serialNumber)

type描述parameter的类型，目前仅支持string。

配置样例：

'{"iotda::certificate::country":{"type":"String"},

"iotda::certificate::organization":{"type":"String"},

"iotda::certificate::organizational_unit":{"type":"String"},

"iotda::certificate::distinguished_name_qualifier":{"type":"String"},

"iotda::certificate::state_name":{"type":"String"},

"iotda::certificate::common_name":{"type":"String"},

"iotda::certificate::serial_number":{"type":"String"}}'

resources

TemplateResource object

预调配模板设备资源结构体。
表12 TemplateResource

参数

参数类型

描述

device

DeviceResource object

预调配模板设备资源详情结构体。

policy

PolicyResource object

预调配模板设备策略资源详情结构体。
表13 DeviceResource

参数

参数类型

描述

device_name

ParameterRef object

设备名称

node_id

ParameterRef object

设备标识码

product_id

Object

参数说明：设备所属的产品id，可以是一个明确的静态字符串id，也可以是动态的模板参数引用

  • 明确的静态字符串："642bf260f2f9030e44210d8d"。取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。"

  • 参数引用: {"ref" : "iotda::certificate::country"}

tags

Array of TagRef objects

参数说明：设备绑定的标签列表
表14 ParameterRef

参数

参数类型

描述

ref

String

参数引用名称
表15 TagRef

参数

参数类型

描述

tag_key

Object

参数说明：标签键名称，可以是一个明确的静态字符串，也可以是动态的模板参数引用

  • 明确的静态字符串："myTagKey"。取值范围：长度不超过64，只允许中文、字母、数字、以及_.-等字符的组合

  • 参数引用: {"ref" : "iotda::certificate::country"}

tag_value

Object

参数说明：标签值，可以是一个明确的静态字符串，也可以是动态的模板参数引用

  • 明确的静态字符串："myTagValue"。取值范围：长度不超过128，只允许中文、字母、数字、以及_.-等字符的组合。

  • 参数引用: {"ref" : "iotda::certificate::country"}
表16 PolicyResource

参数

参数类型

描述

policy_ids

Array of strings

参数说明：设备需要绑定的策略id列表

请求示例

  • 创建预调配模板-参数引用

    POST https://{endpoint}/v5/iot/{project_id}/provisioning-templates

{
  "template_name" : "myTemplate",
  "description" : "myTemplate",
  "template_body" : {
    "parameters" : {
      "iotda::certificate::country" : {
        "type" : "String"
      },
      "iotda::certificate::organization" : {
        "type" : "String"
      },
      "iotda::certificate::organizational_unit" : {
        "type" : "String"
      },
      "iotda::certificate::distinguished_name_qualifier" : {
        "type" : "String"
      },
      "iotda::certificate::state_name" : {
        "type" : "String"
      },
      "iotda::certificate::common_name" : {
        "type" : "String"
      },
      "iotda::certificate::serial_number" : {
        "type" : "String"
      }
    },
    "resources" : {
      "device" : {
        "device_name" : {
          "ref" : "iotda::certificate::organization"
        },
        "node_id" : {
          "ref" : "iotda::certificate::common_name"
        },
        "product_id" : {
          "ref" : "iotda::certificate::organization"
        },
        "tags" : [ {
          "tag_key" : {
            "ref" : "iotda::certificate::organization"
          },
          "tag_value" : {
            "ref" : "iotda::certificate::organizational_unit"
          }
        } ]
      },
      "policy" : {
        "policy_ids" : [ "5c90fa7d3c4e4405e8525079" ]
      }
    }
  }
}

  • 创建预调配模板-部分参数自定义

    POST https://{endpoint}/v5/iot/{project_id}/provisioning-templates

{
  "template_name" : "myTemplate2",
  "description" : "myTemplate2",
  "template_body" : {
    "parameters" : {
      "iotda::certificate::country" : {
        "type" : "String"
      },
      "iotda::certificate::organization" : {
        "type" : "String"
      },
      "iotda::certificate::organizational_unit" : {
        "type" : "String"
      },
      "iotda::certificate::distinguished_name_qualifier" : {
        "type" : "String"
      },
      "iotda::certificate::state_name" : {
        "type" : "String"
      },
      "iotda::certificate::common_name" : {
        "type" : "String"
      },
      "iotda::certificate::serial_number" : {
        "type" : "String"
      }
    },
    "resources" : {
      "device" : {
        "device_name" : {
          "ref" : "iotda::certificate::organization"
        },
        "node_id" : {
          "ref" : "iotda::certificate::common_name"
        },
        "product_id" : "642bf260f2f9030e44210d8d",
        "tags" : [ {
          "tag_key" : "myTagKey",
          "tag_value" : "myTagValue"
        } ]
      },
      "policy" : {
        "policy_ids" : [ "5c90fa7d3c4e4405e8525079" ]
      }
    }
  }
}

响应示例

状态码： 201

Created

{
  "template_id" : "5c90fa7d3c4e4405e8525079",
  "template_name" : "myTemplate",
  "description" : "myTemplate",
  "template_body" : {
    "parameters" : {
      "iotda::certificate::country" : {
        "type" : "String"
      },
      "iotda::certificate::organization" : {
        "type" : "String"
      },
      "iotda::certificate::organizational_unit" : {
        "type" : "String"
      },
      "iotda::certificate::distinguished_name_qualifier" : {
        "type" : "String"
      },
      "iotda::certificate::state_name" : {
        "type" : "String"
      },
      "iotda::certificate::common_name" : {
        "type" : "String"
      },
      "iotda::certificate::serial_number" : {
        "type" : "String"
      }
    },
    "resources" : {
      "device" : {
        "device_name" : {
          "ref" : "iotda::certificate::organization"
        },
        "node_id" : {
          "ref" : "iotda::certificate::common_name"
        },
        "product_id" : {
          "ref" : "iotda::certificate::organization"
        }
      },
      "policy" : {
        "policy_ids" : [ "5c90fa7d3c4e4405e8525079" ]
      }
    }
  },
  "create_time" : "20230810T070547Z",
  "update_time" : "20230810T070547Z"
}

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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
    		 
    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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateProvisioningTemplateSolution {

    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();
        CreateProvisioningTemplateRequest request = new CreateProvisioningTemplateRequest();
        CreateProvisioningTemplate body = new CreateProvisioningTemplate();
        List<String> listPolicyPolicyIds = new ArrayList<>();
        listPolicyPolicyIds.add("5c90fa7d3c4e4405e8525079");
        PolicyResource policyResources = new PolicyResource();
        policyResources.withPolicyIds(listPolicyPolicyIds);
        List<TagRef> listDeviceTags = new ArrayList<>();
        listDeviceTags.add(
            new TagRef()
                .withTagKey("{\"ref\":\"iotda::certificate::organization\"}")
                .withTagValue("{\"ref\":\"iotda::certificate::organizational_unit\"}")
        );
        ParameterRef nodeIdDevice = new ParameterRef();
        nodeIdDevice.withRef("iotda::certificate::common_name");
        ParameterRef deviceNameDevice = new ParameterRef();
        deviceNameDevice.withRef("iotda::certificate::organization");
        DeviceResource deviceResources = new DeviceResource();
        deviceResources.withDeviceName(deviceNameDevice)
            .withNodeId(nodeIdDevice)
            .withProductId("{\"ref\":\"iotda::certificate::organization\"}")
            .withTags(listDeviceTags);
        TemplateResource resourcesTemplateBody = new TemplateResource();
        resourcesTemplateBody.withDevice(deviceResources)
            .withPolicy(policyResources);
        ProvisioningTemplateBody templateBodybody = new ProvisioningTemplateBody();
        templateBodybody.withParameters("{\"iotda::certificate::serial_number\":{\"type\":\"String\"},\"iotda::certificate::organizational_unit\":{\"type\":\"String\"},\"iotda::certificate::state_name\":{\"type\":\"String\"},\"iotda::certificate::distinguished_name_qualifier\":{\"type\":\"String\"},\"iotda::certificate::country\":{\"type\":\"String\"},\"iotda::certificate::organization\":{\"type\":\"String\"},\"iotda::certificate::common_name\":{\"type\":\"String\"}}")
            .withResources(resourcesTemplateBody);
        body.withTemplateBody(templateBodybody);
        body.withDescription("myTemplate");
        body.withTemplateName("myTemplate");
        request.withBody(body);
        try {
            CreateProvisioningTemplateResponse response = client.createProvisioningTemplate(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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
    		 
    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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateProvisioningTemplateSolution {

    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();
        CreateProvisioningTemplateRequest request = new CreateProvisioningTemplateRequest();
        CreateProvisioningTemplate body = new CreateProvisioningTemplate();
        List<String> listPolicyPolicyIds = new ArrayList<>();
        listPolicyPolicyIds.add("5c90fa7d3c4e4405e8525079");
        PolicyResource policyResources = new PolicyResource();
        policyResources.withPolicyIds(listPolicyPolicyIds);
        List<TagRef> listDeviceTags = new ArrayList<>();
        listDeviceTags.add(
            new TagRef()
                .withTagKey("myTagKey")
                .withTagValue("myTagValue")
        );
        ParameterRef nodeIdDevice = new ParameterRef();
        nodeIdDevice.withRef("iotda::certificate::common_name");
        ParameterRef deviceNameDevice = new ParameterRef();
        deviceNameDevice.withRef("iotda::certificate::organization");
        DeviceResource deviceResources = new DeviceResource();
        deviceResources.withDeviceName(deviceNameDevice)
            .withNodeId(nodeIdDevice)
            .withProductId("642bf260f2f9030e44210d8d")
            .withTags(listDeviceTags);
        TemplateResource resourcesTemplateBody = new TemplateResource();
        resourcesTemplateBody.withDevice(deviceResources)
            .withPolicy(policyResources);
        ProvisioningTemplateBody templateBodybody = new ProvisioningTemplateBody();
        templateBodybody.withParameters("{\"iotda::certificate::serial_number\":{\"type\":\"String\"},\"iotda::certificate::organizational_unit\":{\"type\":\"String\"},\"iotda::certificate::state_name\":{\"type\":\"String\"},\"iotda::certificate::distinguished_name_qualifier\":{\"type\":\"String\"},\"iotda::certificate::country\":{\"type\":\"String\"},\"iotda::certificate::organization\":{\"type\":\"String\"},\"iotda::certificate::common_name\":{\"type\":\"String\"}}")
            .withResources(resourcesTemplateBody);
        body.withTemplateBody(templateBodybody);
        body.withDescription("myTemplate2");
        body.withTemplateName("myTemplate2");
        request.withBody(body);
        try {
            CreateProvisioningTemplateResponse response = client.createProvisioningTemplate(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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
    		 
    # 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接入地址。
    iotdaEndpoint = "<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) \
        # 标准版/企业版：需要使用自行创建的Region对象，基础版：请选择IoTDAClient中的Region对象 如： .with_region(IoTDARegion.CN_NORTH_4)
        .with_region(coreRegion(id="cn-north-4", endpoint=endpoint)) \
        .build()

    try:
        request = CreateProvisioningTemplateRequest()
        listPolicyIdsPolicy = [
            "5c90fa7d3c4e4405e8525079"
        ]
        policyResources = PolicyResource(
            policy_ids=listPolicyIdsPolicy
        )
        listTagsDevice = [
            TagRef(
                tag_key="{\"ref\":\"iotda::certificate::organization\"}",
                tag_value="{\"ref\":\"iotda::certificate::organizational_unit\"}"
            )
        ]
        nodeIdDevice = ParameterRef(
            ref="iotda::certificate::common_name"
        )
        deviceNameDevice = ParameterRef(
            ref="iotda::certificate::organization"
        )
        deviceResources = DeviceResource(
            device_name=deviceNameDevice,
            node_id=nodeIdDevice,
            product_id="{\"ref\":\"iotda::certificate::organization\"}",
            tags=listTagsDevice
        )
        resourcesTemplateBody = TemplateResource(
            device=deviceResources,
            policy=policyResources
        )
        templateBodybody = ProvisioningTemplateBody(
            parameters="{\"iotda::certificate::serial_number\":{\"type\":\"String\"},\"iotda::certificate::organizational_unit\":{\"type\":\"String\"},\"iotda::certificate::state_name\":{\"type\":\"String\"},\"iotda::certificate::distinguished_name_qualifier\":{\"type\":\"String\"},\"iotda::certificate::country\":{\"type\":\"String\"},\"iotda::certificate::organization\":{\"type\":\"String\"},\"iotda::certificate::common_name\":{\"type\":\"String\"}}",
            resources=resourcesTemplateBody
        )
        request.body = CreateProvisioningTemplate(
            template_body=templateBodybody,
            description="myTemplate",
            template_name="myTemplate"
        )
        response = client.create_provisioning_template(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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
    		 
    # 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接入地址。
    iotdaEndpoint = "<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) \
        # 标准版/企业版：需要使用自行创建的Region对象，基础版：请选择IoTDAClient中的Region对象 如： .with_region(IoTDARegion.CN_NORTH_4)
        .with_region(coreRegion(id="cn-north-4", endpoint=endpoint)) \
        .build()

    try:
        request = CreateProvisioningTemplateRequest()
        listPolicyIdsPolicy = [
            "5c90fa7d3c4e4405e8525079"
        ]
        policyResources = PolicyResource(
            policy_ids=listPolicyIdsPolicy
        )
        listTagsDevice = [
            TagRef(
                tag_key="myTagKey",
                tag_value="myTagValue"
            )
        ]
        nodeIdDevice = ParameterRef(
            ref="iotda::certificate::common_name"
        )
        deviceNameDevice = ParameterRef(
            ref="iotda::certificate::organization"
        )
        deviceResources = DeviceResource(
            device_name=deviceNameDevice,
            node_id=nodeIdDevice,
            product_id="642bf260f2f9030e44210d8d",
            tags=listTagsDevice
        )
        resourcesTemplateBody = TemplateResource(
            device=deviceResources,
            policy=policyResources
        )
        templateBodybody = ProvisioningTemplateBody(
            parameters="{\"iotda::certificate::serial_number\":{\"type\":\"String\"},\"iotda::certificate::organizational_unit\":{\"type\":\"String\"},\"iotda::certificate::state_name\":{\"type\":\"String\"},\"iotda::certificate::distinguished_name_qualifier\":{\"type\":\"String\"},\"iotda::certificate::country\":{\"type\":\"String\"},\"iotda::certificate::organization\":{\"type\":\"String\"},\"iotda::certificate::common_name\":{\"type\":\"String\"}}",
            resources=resourcesTemplateBody
        )
        request.body = CreateProvisioningTemplate(
            template_body=templateBodybody,
            description="myTemplate2",
            template_name="myTemplate2"
        )
        response = client.create_provisioning_template(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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
    		 
    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.CreateProvisioningTemplateRequest{}
	var listPolicyIdsPolicy = []string{
        "5c90fa7d3c4e4405e8525079",
    }
	policyResources := &model.PolicyResource{
		PolicyIds: &listPolicyIdsPolicy,
	}
	tagKeyTags:= "{\"ref\":\"iotda::certificate::organization\"}"
	var tagKeyTagsInterface interface{} = tagKeyTags
	tagValueTags:= "{\"ref\":\"iotda::certificate::organizational_unit\"}"
	var tagValueTagsInterface interface{} = tagValueTags
	var listTagsDevice = []model.TagRef{
        {
            TagKey: &tagKeyTagsInterface,
            TagValue: &tagValueTagsInterface,
        },
    }
	nodeIdDevice := &model.ParameterRef{
		Ref: "iotda::certificate::common_name",
	}
	deviceNameDevice := &model.ParameterRef{
		Ref: "iotda::certificate::organization",
	}
	var productIdDevice interface{} = "{\"ref\":\"iotda::certificate::organization\"}"
	deviceResources := &model.DeviceResource{
		DeviceName: deviceNameDevice,
		NodeId: nodeIdDevice,
		ProductId: &productIdDevice,
		Tags: &listTagsDevice,
	}
	resourcesTemplateBody := &model.TemplateResource{
		Device: deviceResources,
		Policy: policyResources,
	}
	var parametersTemplateBody interface{} = "{\"iotda::certificate::serial_number\":{\"type\":\"String\"},\"iotda::certificate::organizational_unit\":{\"type\":\"String\"},\"iotda::certificate::state_name\":{\"type\":\"String\"},\"iotda::certificate::distinguished_name_qualifier\":{\"type\":\"String\"},\"iotda::certificate::country\":{\"type\":\"String\"},\"iotda::certificate::organization\":{\"type\":\"String\"},\"iotda::certificate::common_name\":{\"type\":\"String\"}}"
	templateBodybody := &model.ProvisioningTemplateBody{
		Parameters: &parametersTemplateBody,
		Resources: resourcesTemplateBody,
	}
	descriptionCreateProvisioningTemplate:= "myTemplate"
	request.Body = &model.CreateProvisioningTemplate{
		TemplateBody: templateBodybody,
		Description: &descriptionCreateProvisioningTemplate,
		TemplateName: "myTemplate",
	}
	response, err := client.CreateProvisioningTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 创建预调配模板-部分参数自定义

     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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
    		 
    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.CreateProvisioningTemplateRequest{}
	var listPolicyIdsPolicy = []string{
        "5c90fa7d3c4e4405e8525079",
    }
	policyResources := &model.PolicyResource{
		PolicyIds: &listPolicyIdsPolicy,
	}
	tagKeyTags:= "myTagKey"
	var tagKeyTagsInterface interface{} = tagKeyTags
	tagValueTags:= "myTagValue"
	var tagValueTagsInterface interface{} = tagValueTags
	var listTagsDevice = []model.TagRef{
        {
            TagKey: &tagKeyTagsInterface,
            TagValue: &tagValueTagsInterface,
        },
    }
	nodeIdDevice := &model.ParameterRef{
		Ref: "iotda::certificate::common_name",
	}
	deviceNameDevice := &model.ParameterRef{
		Ref: "iotda::certificate::organization",
	}
	var productIdDevice interface{} = "642bf260f2f9030e44210d8d"
	deviceResources := &model.DeviceResource{
		DeviceName: deviceNameDevice,
		NodeId: nodeIdDevice,
		ProductId: &productIdDevice,
		Tags: &listTagsDevice,
	}
	resourcesTemplateBody := &model.TemplateResource{
		Device: deviceResources,
		Policy: policyResources,
	}
	var parametersTemplateBody interface{} = "{\"iotda::certificate::serial_number\":{\"type\":\"String\"},\"iotda::certificate::organizational_unit\":{\"type\":\"String\"},\"iotda::certificate::state_name\":{\"type\":\"String\"},\"iotda::certificate::distinguished_name_qualifier\":{\"type\":\"String\"},\"iotda::certificate::country\":{\"type\":\"String\"},\"iotda::certificate::organization\":{\"type\":\"String\"},\"iotda::certificate::common_name\":{\"type\":\"String\"}}"
	templateBodybody := &model.ProvisioningTemplateBody{
		Parameters: &parametersTemplateBody,
		Resources: resourcesTemplateBody,
	}
	descriptionCreateProvisioningTemplate:= "myTemplate2"
	request.Body = &model.CreateProvisioningTemplate{
		TemplateBody: templateBodybody,
		Description: &descriptionCreateProvisioningTemplate,
		TemplateName: "myTemplate2",
	}
	response, err := client.CreateProvisioningTemplate(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： 预调配模板管理

相关文档