Provisioning Produk IoT Platform via ALIYUN::IOT::Product - ROS

ALIYUN::IOT::Product digunakan untuk membuat produk.

Shanghai
Singapura (Singapura)
Jepang (Tokyo)
Jerman (Frankfurt)
AS (Silicon Valley)
AS (Virginia)

Sintaksis

{
  "Type": "ALIYUN::IOT::Product",
  "Properties": {
    "AuthType": String,
    "NodeType": Integer,
    "Description": String,
    "CategoryKey": String,
    "IotInstanceId": String,
    "ProtocolType": String,
    "PublishAuto": Boolean,
    "Id2": Boolean,
    "ProductName": String,
    "ResourceGroupId": String,
    "DataFormat": Integer,
    "AliyunCommodityCode": String,
    "JoinPermissionId": String,
    "NetType": String
  }
}

Properti

Parameter	Tipe	Diperlukan	Dapat Diedit	Deskripsi	Batasan
AuthType	String	Tidak	Dirilis	Jenis autentikasi untuk perangkat dari suatu produk untuk mengakses IoT Platform.	Nilai yang valid: secret: Rahasia perangkat digunakan untuk otentikasi perangkat. id2: Menggunakan id² dari perangkat IoT untuk otentikasi identitas. x509: Gunakan sertifikat X.509 perangkat untuk otentikasi perangkat.
NodeType	Integer	Ya	Tidak didukung	Jenis node dari produk.	Parameter ini hanya tersedia untuk AliyunCommodityCode=iothub_senior. Nilai yang valid: 0: Perangkat. Perangkat tidak dapat dipasangi sub-perangkat. Anda dapat menghubungkan IoT Platform ke platform IoT baik secara langsung atau sebagai sub-perangkat dari gateway IoT Platform. 1: Gateway. Gateway dapat dipasangi sub-perangkat. Ini dapat mengelola sub-perangkat, mempertahankan hubungan topologi dengan sub-perangkat, dan menyinkronkan hubungan topologi tersebut ke IoT Platform.
Description	String	Tidak didukung	Didukung	Informasi deskripsi produk	Tidak ada
CategoryKey	String	Tidak	Dirilis	Pengenal kategori produk.	Jika Anda menentukan parameter ini, produk yang dibuat akan menggunakan TSL dari kategori yang ditentukan. Jika Anda tidak menentukan parameter ini, TSL standar dari kategori apa pun tidak akan digunakan.
IotInstanceId	String	Tidak	Dirilis	ID instance.	Parameter ini tidak diperlukan untuk instance publik.
ProtocolType	String	Tidak	Dirilis	Jenis protokol saat perangkat terhubung ke Gateway.	Jika Anda ingin menghubungkan perangkat dari AliyunCommodityCode=iothub_senior ke IoT Platform melalui gateway, Anda harus menentukan parameter ini. Nilai yang valid: modbus: Protokol Modbus opc-ua: Protokol OPC UA customize: Menyesuaikan protokol ble: BLE. zigbee: Protokol ZigBee
PublishAuto	Boolean	Dihapus	Dirilis	Menunjukkan apakah akan secara otomatis menerbitkan TSL setelah produk dibuat.	Nilai yang valid: true (default) false
Id2	Boolean	Dihapus	Dirilis	Apakah menggunakan autentikasi id²	Nilai yang valid: true false (default) Otentikasi id² hanya didukung di wilayah China (Shanghai). Jika Anda mengatur parameter AuthType ke true tetapi mengatur parameter AuthType ke id2, Oss menggunakan parameter AuthType.
ProductName	String	Ya	Ya	Nama Produk	Nama harus memiliki panjang 4 hingga 30 karakter, dan dapat berisi karakter Cina, huruf besar, huruf kecil, angka, dan garis bawah (_). Catatan Satu karakter Cina dihitung dua.
ResourceGroupId	String	Tidak	Ya	ID grup sumber daya.	Tidak ada
DataFormat	Integer	Dihapus	Dirilis	Format data tipe produk	Parameter ini hanya tersedia untuk AliyunCommodityCode=iothub_senior. Nilai yang valid: 0: Jangan parsing /custom (CUSTOM_FORMAT) 1: Protokol Alink (ALINK_FORMAT)
AliyunCommodityCode	String	Tidak	Dirilis	Tipe produk	Nilai yang valid: iothub_senior: Menggunakan model TSL. iothub: Tanpa model TSL
JoinPermissionId	String	Tidak	Dirilis	ID kredensial masuk LoRaWAN	Metode koneksi jaringan `NetType` jika Anda mengatur parameter ini ke LORA, parameter ini diperlukan.
NetType	String	Tidak	Dirilis	Metode Koneksi Jaringan	Jika Anda menggunakan AliyunCommodityCode=iothub_senior dan perangkat dari produk ini adalah gateway atau perangkat yang tidak terhubung ke gateway, Anda harus menentukan parameter ini. Nilai yang valid: WIFI (default): WiFi CELLULAR ETHERNET LORA:LoRaWAN OTHER

Nilai Pengembalian

Fn::GetAtt

ProductKey: Pengenal produk.
IotInstanceId: ID instance.

Contoh

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Product": {
      "Type": "ALIYUN::IOT::Product",
      "Properties": {
        "AuthType": {
          "Ref": "AuthType"
        },
        "NodeType": {
          "Ref": "NodeType"
        },
        "Description": {
          "Ref": "Description"
        },
        "CategoryKey": {
          "Ref": "CategoryKey"
        },
        "IotInstanceId": {
          "Ref": "IotInstanceId"
        },
        "ProtocolType": {
          "Ref": "ProtocolType"
        },
        "PublishAuto": {
          "Ref": "PublishAuto"
        },
        "Id2": {
          "Ref": "Id2"
        },
        "ProductName": {
          "Ref": "ProductName"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "DataFormat": {
          "Ref": "DataFormat"
        },
        "AliyunCommodityCode": {
          "Ref": "AliyunCommodityCode"
        },
        "JoinPermissionId": {
          "Ref": "JoinPermissionId"
        },
        "NetType": {
          "Ref": "NetType"
        }
      }
    }
  },
  "Parameters": {
    "AuthType": {
      "Type": "String",
      "Description": "Perangkat autentikasi untuk mengakses platform Internet of Things di bawah produk. Pilihan:\nsecret: menggunakan kunci perangkat untuk otentikasi perangkat.\nDetail dapat ditemukan dalam komunikasi koneksi MQTT-TCP.\nid2: Gunakan ID autentikasi perangkat things.\nx509: Menggunakan sertifikat X.509 perangkat untuk otentikasi perangkat.\nPenggunaan instruksi konfigurasi sisi perangkat sertifikat X.509, lihat Menggunakan otentikasi sertifikat X.509.\nJika parameter ini dilewatkan, nilai defaultnya adalah secret."
    },
    "NodeType": {
      "Type": "Number",
      "Description": "Jenis node dari produk. Nilai:\n0: Perangkat. Perangkat tidak dapat dipasangi sub-perangkat. Dapat terhubung ke IoT Platform\neither langsung atau sebagai sub-perangkat dari gateway.\n1: Gateway. Gateway dapat dipasangi sub-perangkat. Dapat mengelola sub-perangkat, mempertahankan\nhubungan topologi dengan sub-perangkat, dan menyinkronkan hubungan topologi\ndengan IoT Platform.",
      "AllowedValues": [
        0,
        1
      ]
    },
    "Description": {
      "Type": "String",
      "Description": "Deskripsi produk. Deskripsi dapat memiliki panjang maksimal 100 karakter."
    },
    "CategoryKey": {
      "Type": "String",
      "Description": "Pengenal kategori produk. Jika Anda melewati parameter ini, produk akan dibuat menggunakan model objek kategori yang ditentukan; jika tidak dilewatkan, model standar tidak digunakan dalam kategori apa pun.\nPanggil ListThingTemplates, lihat informasi kategori yang telah ditentukan sebelumnya dari platform things dari hasil yang dikembalikan, dapatkan nilai CategoryKey."
    },
    "IotInstanceId": {
      "Type": "String",
      "Description": "Instance publik tidak melewati parameter ini; instance yang perlu Anda beli menggunakan ID instance yang masuk."
    },
    "ProtocolType": {
      "Type": "String",
      "Description": "Protokol yang digunakan perangkat dari produk ini untuk terhubung ke gateway.\nTetapkan parameter ini hanya jika Anda membuat produk yang perangkatnya akan terhubung\nke gateway.\nPilihan:\nmodbus: Modbus.\nopc-ua: OPC UA.\ncustomize: Protokol yang disesuaikan.\nble: BLE.\nzigbee: ZigBee.",
      "AllowedValues": [
        "ble",
        "customize",
        "modbus",
        "opc-ua",
        "zigbee"
      ]
    },
    "PublishAuto": {
      "Type": "Boolean",
      "Description": "Apakah akan secara otomatis menerbitkan model setelah produk dibuat.\ntrue: menerbitkan.\nfalse: tidak dirilis.\nParameter ini tidak dilewatkan, nilai defaultnya adalah true.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Id2": {
      "Type": "Boolean",
      "Description": "Apakah sertifikasi ID2.\nPilihan nilai:\ntrue: membuka sertifikasi ID2.\nfalse: tidak membuka sertifikasi ID2.\nJangan lewatkan parameter ini, defaultnya adalah tidak dibuka.\nPenjelasan\nHanya wilayah Timur Tiongkok (Shanghai) yang mendukung otentikasi ID2.\nJika nilai parameter ini diatur ke true, tetapi nilai parameter AuthType yang dilewatkan bukan id2, sistem akan menggunakan nilai parameter AuthType.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "ProductName": {
      "Type": "String",
      "Description": "Nama produk. Nama produk dapat memiliki panjang 4 hingga 30 karakter dan dapat\nberisi karakter Cina, huruf besar, huruf kecil, angka, dan garis bawah (_).\nCatatan Nama produk harus unik dalam akun."
    },
    "ResourceGroupId":"",
      "Type": "String",
      "Description": "ID grup sumber daya (ID grup untuk melihat sumber daya di konsol manajemen sumber daya), tentukan produk diklasifikasikan sebagai grup sumber daya.\nJika parameter ini dilewatkan, produk akan diklasifikasikan sebagai grup sumber daya default."
    },
    "DataFormat": {
      "Type": "Number",
      "Description": "Anda harus menentukan parameter ini jika nilai AliyunCommodityCode adalah iothub_senior.\nParameter ini hanya tersedia dan diperlukan saat Anda membuat produk Edisi Pro.\nPilihan:\n0: Jangan parsing/Custom.\n1: Alink JSON.",
      "AllowedValues": [
        0,
        1
      ]
    },
    "AliyunCommodityCode": {
      "Type": "String",
      "Description": "Edisi produk yang ingin Anda buat. Ada dua pilihan:\niothub_senior: Edisi Pro.\niothub: Edisi Dasar.\nJika Anda tidak memasukkan parameter ini, nilai default yang digunakan adalah iothub (Edisi Dasar)."
    },
    "JoinPermissionId": {
      "Type": "String",
      "Description": "ID kredensial jaringan LoRaWAN. Saat mode jaringan NetType memilih LORA, parameter yang diperlukan.\nSilakan panggil QueryLoRaJoinPermissions untuk menanyakan JoinPermissionId kredensial jaringan LoRaWAN di bawah akun Anda.\nJika Anda tidak memiliki kredensial jaringan LoRaWAN, kunjungi platform manajemen jaringan untuk membuat bersama."
    },
    "NetType": {
      "Type": "String",
      "Description": "Mode jaringan.\nTetapkan parameter ini hanya jika Anda membuat produk yang perangkatnya terhubung langsung ke IoT Platform.\nPilihan:\nWIFI\nCELLULAR\nETHERNET\nOTHER\nNilai defaultnya adalah WIFI.",
      "AllowedValues": [
        "CELLULAR",
        "ETHERNET",
        "LORA",
        "OTHER",
        "WIFI"
      ]
    }
  },
  "Outputs": {
    "ProductKey": {
      "Description": "Pengenal unik global produk yang dikeluarkan oleh IoT Platform.",
      "Value": {
        "Fn::GetAtt": [
          "Product",
          "ProductKey"
        ]
      }
    },
    "IotInstanceId": {
      "Description": "ID instance IOT.",
      "Value": {
        "Fn::GetAtt": [
          "Product",
          "IotInstanceId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Product:
    Type: 'ALIYUN::IOT::Product'
    Properties:
      AuthType:
        Ref: AuthType
      NodeType:
        Ref: NodeType
      Description:
        Ref: Description
      CategoryKey:
        Ref: CategoryKey
      IotInstanceId:
        Ref: IotInstanceId
      ProtocolType:
        Ref: ProtocolType
      PublishAuto:
        Ref: PublishAuto
      Id2:
        Ref: Id2
      ProductName:
        Ref: ProductName
      ResourceGroupId:
        Ref: ResourceGroupId
      DataFormat:
        Ref: DataFormat
      AliyunCommodityCode:
        Ref: AliyunCommodityCode
      JoinPermissionId:
        Ref: JoinPermissionId
      NetType:
        Ref: NetType
Parameters:
  AuthType:
    Type: String
    Description: >-
      Perangkat autentikasi untuk mengakses platform Internet of Things di bawah
      produk. Pilihan:

      secret: menggunakan kunci perangkat untuk otentikasi perangkat.

      Detail dapat ditemukan dalam komunikasi koneksi MQTT-TCP.

      id2: Gunakan ID autentikasi perangkat things.

      x509: Menggunakan sertifikat X.509 perangkat untuk otentikasi perangkat.

      Penggunaan instruksi konfigurasi sisi perangkat sertifikat X.509, lihat
      Menggunakan otentikasi sertifikat X.509.

      Jika parameter ini dilewatkan, nilai defaultnya adalah secret.
  NodeType:
    Type: Number
    Description: >-
      Jenis node dari produk. Nilai:

      0: Perangkat. Perangkat tidak dapat dipasangi sub-perangkat. Dapat terhubung ke
      IoT Platform

      baik langsung atau sebagai sub-perangkat dari gateway.

      1: Gateway. Gateway dapat dipasangi sub-perangkat. Dapat mengelola
      sub-perangkat, mempertahankan

      hubungan topologi dengan sub-perangkat dan menyinkronkan hubungan topologi

      dengan IoT Platform.
    AllowedValues:
      -0
      - 1
  Description:
    Type: String
    Description: >-
      Deskripsi produk. Deskripsi dapat memiliki panjang maksimal 100
      karakter.

      panjang.
  CategoryKey:
    Type: String
    Description: >-
      Pengenal kategori produk. Jika Anda melewati parameter ini dan produk akan
      dibuat menggunakan model objek kategori yang ditentukan; jika tidak dilewatkan, model
      standar tidak digunakan dalam kategori apa pun.

      Panggil ListThingTemplates, lihat informasi kategori yang telah ditentukan sebelumnya dari
      platform things dari hasil yang dikembalikan, dapatkan nilai CategoryKey.
  IotInstanceId:
    Type: String
    Description: >-
      Instance publik tidak melewati parameter ini; instance yang perlu Anda beli
      menggunakan ID instance yang masuk.
  ProtocolType:
    Type: String
    Description: >-
      Protokol yang digunakan perangkat dari produk ini untuk terhubung ke gateway.

      Tetapkan parameter ini hanya jika Anda membuat produk yang perangkatnya akan
      terhubung

      ke gateway.

      Pilihan:

      modbus: Modbus.

      opc-ua: OPC UA.

      customize: Protokol yang disesuaikan.

      ble: BLE.

      zigbee: ZigBee.
    AllowedValues:
      -ble
      -customize
      -modbus
      -opc-ua
      -zigbee
  PublishAuto:
    Type: Boolean
    Description: |-
      Apakah akan secara otomatis menerbitkan model setelah produk dibuat.
      true: menerbitkan.
      false: tidak dirilis.
      Parameter ini tidak dilewatkan, nilai defaultnya adalah true.
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
  Id2:
    Type: Boolean
    Description: >-
      Apakah sertifikasi ID2.

      Pilihan nilai:

      true: membuka sertifikasi ID2.

      false: tidak membuka sertifikasi ID2.

      Jangan lewatkan parameter ini, defaultnya adalah tidak dibuka.

      Penjelasan

      Hanya wilayah Timur Tiongkok (Shanghai) yang mendukung otentikasi ID2.

      Jika nilai parameter ini diatur ke true dan tetapi nilai parameter AuthType yang
      dilewatkan bukan id2, sistem akan menggunakan nilai parameter AuthType.
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
  ProductName:
    Type: String
    Description: >-
      Nama produk. Nama produk dapat memiliki panjang 4 hingga 30 karakter dan dapat

      berisi karakter Cina, huruf besar, huruf kecil, angka, dan garis bawah (_).

      Catatan Nama produk harus unik dalam akun.
  ResourceGroupId:
    Type: String
    Description: >-
      ID grup sumber daya (ID grup untuk melihat sumber daya di konsol manajemen
      sumber daya), tentukan produk diklasifikasikan sebagai grup sumber daya.

      Jika parameter ini dilewatkan dan produk akan diklasifikasikan sebagai default
      grup sumber daya.
  DataFormat:
    Type: Number
    Description: >-
      Anda harus menentukan parameter ini jika nilai AliyunCommodityCode adalah
      iothub_senior.

      Parameter ini hanya tersedia dan diperlukan saat Anda membuat produk Edisi Pro.

      Pilihan:

      0: Jangan parsing/Custom.

      1: Alink JSON.
    AllowedValues:
      -0
      - 1
  AliyunCommodityCode:
    Type: String
    Description: >-
      Edisi produk yang ingin Anda buat. Ada dua pilihan:

      iothub_senior: Edisi Pro.

      iothub: Edisi Dasar.

      Jika Anda tidak memasukkan parameter ini, nilai default yang digunakan adalah
      iothub (Edisi Dasar).
  JoinPermissionId:
    Type: String
    Description: >-
      ID kredensial jaringan LoRaWAN. Saat mode jaringan NetType memilih LORA,
      parameter yang diperlukan.

      Silakan panggil QueryLoRaJoinPermissions untuk menanyakan JoinPermissionId
      kredensial jaringan LoRaWAN di bawah akun Anda.

      Jika Anda tidak memiliki kredensial jaringan LoRaWAN dan kunjungi platform manajemen
      jaringan untuk membuat bersama.
  NetType:
    Type: String
    Description: >-
      Mode jaringan.

      Tetapkan parameter ini hanya jika Anda membuat produk yang perangkatnya
      terhubung langsung

      ke IoT Platform.

      Pilihan:

      Wi-Fi

      CELLULAR

      ETHERNET

      OTHER

      Nilai defaultnya adalah WIFI.
    AllowedValues:
      -CELLULAR
      -ETHERNET
      -LORA
      -OTHER
      -WIFI
Outputs:
  ProductKey:
    Description: Pengenal unik global produk yang dikeluarkan oleh IoT Platform.
    Value:
      'Fn::GetAtt':
        -Product
        -ProductKey
  IotInstanceId:
    Description: ID instance IOT.
    Value:
      'Fn::GetAtt':
        -Product
        -IotInstanceId