Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
ListProperties
API ini mencantumkan properti komponen.
Minta Sintaks
POST /workspaces/workspaceId/properties-list HTTP/1.1
Content-type: application/json
{
"componentName": "string",
"componentPath": "string",
"entityId": "string",
"maxResults": number,
"nextToken": "string"
}Parameter Permintaan URI
Permintaan menggunakan parameter URI berikut.
- workspaceId
-
ID ruang kerja.
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.
- componentName
-
Nama komponen yang propertinya dikembalikan oleh operasi.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.
Pola:
[a-zA-Z_\-0-9]+Wajib: Tidak
- componentPath
-
String ini menentukan jalur ke komponen komposit, mulai dari komponen tingkat atas.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 2048.
Pola:
[a-zA-Z_\-0-9/]+Wajib: Tidak
- entityId
-
ID untuk entitas yang metadatanya (komponen/properti) dikembalikan oleh operasi.
Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.
Pola:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+Wajib: Ya
- maxResults
-
Jumlah maksimum hasil yang dikembalikan pada satu waktu. Default-nya adalah 25.
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",
"propertySummaries": [
{
"areAllPropertyValuesReturned": boolean,
"definition": {
"configuration": {
"string" : "string"
},
"dataType": {
"allowedValues": [
{
"booleanValue": boolean,
"doubleValue": number,
"expression": "string",
"integerValue": number,
"listValue": [
"DataValue"
],
"longValue": number,
"mapValue": {
"string" : "DataValue"
},
"relationshipValue": {
"targetComponentName": "string",
"targetEntityId": "string"
},
"stringValue": "string"
}
],
"nestedType": "DataType",
"relationship": {
"relationshipType": "string",
"targetComponentTypeId": "string"
},
"type": "string",
"unitOfMeasure": "string"
},
"defaultValue": {
"booleanValue": boolean,
"doubleValue": number,
"expression": "string",
"integerValue": number,
"listValue": [
"DataValue"
],
"longValue": number,
"mapValue": {
"string" : "DataValue"
},
"relationshipValue": {
"targetComponentName": "string",
"targetEntityId": "string"
},
"stringValue": "string"
},
"displayName": "string",
"isExternalId": boolean,
"isFinal": boolean,
"isImported": boolean,
"isInherited": boolean,
"isRequiredInEntity": boolean,
"isStoredExternally": boolean,
"isTimeSeries": boolean
},
"propertyName": "string",
"value": {
"booleanValue": boolean,
"doubleValue": number,
"expression": "string",
"integerValue": number,
"listValue": [
"DataValue"
],
"longValue": number,
"mapValue": {
"string" : "DataValue"
},
"relationshipValue": {
"targetComponentName": "string",
"targetEntityId": "string"
},
"stringValue": "string"
}
}
]
}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 properti.
Jenis: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 17880.
Pola:
.* - propertySummaries
-
Daftar objek yang berisi informasi tentang properti.
Tipe: Array objek PropertySummary
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
- ResourceNotFoundException
-
Sumber daya tidak ditemukan.
Kode Status HTTP: 404
- 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:
