Query Pre-provisioning Template Details

Function

This API is used by an application to query details about a pre-provisioning template with a specified ID on the IoT platform.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v5/iot/{project_id}/provisioning-templates/{template_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
template_id	Yes	String	Pre-provisioning template ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. Obtain the token by calling the IAM API for obtaining a user token through password authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
template_id	String	Parameter description: ID of the pre-provisioning template.
template_name	String	Parameter description: name of the pre-provisioning template. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
description	String	Parameter description: description of the pre-provisioning template. Value: The value can contain a maximum of 2,048 characters. Only letters, digits, and special characters (_?'#().,&%@!-) are allowed. Maximum: 2048
template_body	ProvisioningTemplateBody object	Parameter description: detailed content of the pre-provisioning template in JSON format.
create_time	String	Time when a pre-provisioning template is created on the IoT platform. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.
update_time	String	Time when the pre-provisioning template is updated in the IoT platform. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

**Table 4** ProvisioningTemplateBody
Parameter	Type	Description
parameters	Object	Parameter description: pre-provisioning template parameters, which can be extracted from the user fields of pre-provisioning device certificates. The configuration format is {"parameter":{"type":"String"}}. Huawei Cloud IoT platform defines the parameters that can be declared and referenced in pre-provisioning templates. A device certificate must contain the parameters referenced in the template. iotda::certificate::country: country/region, C iotda::certificate::organization: organization, O iotda::certificate::organizational_unit: organizational unit, OU iotda::certificate::distinguished_name_qualifier: distinguishable name qualifier, dnQualifier iotda::certificate::state_name: province, ST iotda::certificate::common_name: common name, CN iotda::certificate::serial_number: serial number, serialNumber type indicates the parameter type. Currently, only String is supported. Configuration example: '{"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	Structure of device resources of a pre-provisioning template.

**Table 5** TemplateResource
Parameter	Type	Description
device	DeviceResource object	Structure of device resource details of a pre-provisioning template.
policy	PolicyResource object	Structure of device policy resource details of a pre-provisioning template.

**Table 6** DeviceResource
Parameter	Type	Description
device_name	ParameterRef object	Device name.
node_id	ParameterRef object	Node ID.
product_id	Object	Parameter description: ID of the product to which the device belongs. The value can be a static string ID or dynamic parameters referenced from the template. Static string: 642bf260f2f9030e44210d8d. Value: The value can contain a maximum of 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. " Parameter reference: {"ref": "iotda::certificate::country"}
tags	Array of TagRef objects	Parameter description: list of tags bound to a device.

**Table 7** ParameterRef
Parameter	Type	Description
ref	String	Parameter reference name.

**Table 8** TagRef
Parameter	Type	Description
tag_key	Object	Parameter description: tag key name. The value can be a static string or dynamic parameters referenced from the template. Static string: myTagKey. Value: The value can contain a maximum of 64 characters. Only letters, digits, underscores (_), periods (.), and hyphens (-) are allowed. Parameter reference: {"ref": "iotda::certificate::country"}
tag_value	Object	Parameter description: tag value. The value can be a static string or dynamic parameters referenced from the template. Static string: "myTagValue". Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), periods (.), and hyphens (-) are allowed. Parameter reference: {"ref": "iotda::certificate::country"}

**Table 9** PolicyResource
Parameter	Type	Description
policy_ids	Array of strings	Parameter description: ID list of policies to be bound to a device.

Example Requests

Queries details about a pre-provisioning template with a specified ID.

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

Example Responses

Status code: 200

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