ListSyncResources - AWS IoT TwinMaker
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

ListSyncResources

Daftar sumber daya sinkronisasi.

Minta Sintaks

POST /workspaces/workspaceId/sync-jobs/syncSource/resources-list HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { ... }
   ],
   "maxResults": number,
   "nextToken": "string"
}

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

syncSource

Sumber sinkronisasi.

catatan

Saat ini satu-satunya SyncSource yang didukung adalah. SITEWISE

Pola: [a-zA-Z_0-9]+

Wajib: Ya

workspaceId

ID ruang kerja yang berisi pekerjaan sinkronisasi.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Wajib: Ya

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

filters

Daftar objek yang memfilter permintaan.

Kombinasi filter berikut didukung:

  • Filter dengan status

  • Filter dengan ResourceType dan ResourceId

  • Filter dengan ResourceType dan ExternalId

Tipe: Array objek SyncResourceFilter

Wajib: Tidak

maxResults

Jumlah maksimum hasil untuk kembali pada satu waktu. Defaultnya adalah 50.

Rentang yang Valid: Nilai minimum 0. Nilai maksimum 200.

Tipe: Bilangan Bulat

Rentang yang Valid: Nilai minimum 0. Nilai maksimum 200.

Wajib: Tidak

nextToken

String yang menentukan halaman berikutnya dari hasil.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.

Pola: .*

Diperlukan: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "syncResources": [ 
      { 
         "externalId": "string",
         "resourceId": "string",
         "resourceType": "string",
         "status": { 
            "error": { 
               "code": "string",
               "message": "string"
            },
            "state": "string"
         },
         "updateDateTime": number
      }
   ]
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

nextToken

String yang menentukan halaman berikutnya dari hasil.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.

Pola: .*

syncResources

Sumber daya sinkronisasi.

Tipe: Array objek SyncResourceSummary

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

AccessDeniedException

Akses ditolak.

Kode Status HTTP: 403

InternalServerException

Terjadi kesalahan tak terduga.

Kode Status HTTP: 500

ServiceQuotaExceededException

Kuota layanan terlampaui.

Kode Status HTTP: 402

ThrottlingException

Tarif melebihi batas.

Kode Status HTTP: 429

ValidationException

Failed

Kode Status HTTP: 400

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: