Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris. # GetEntity Mengambil informasi tentang suatu entitas. ## Minta Sintaks ``` GET /workspaces/workspaceId/entities/entityId HTTP/1.1 ``` ## Parameter Permintaan URI Permintaan menggunakan parameter URI berikut. ** [entityId](#API_GetEntity_RequestSyntax) ** ID entitas. 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 ** [workspaceId](#API_GetEntity_RequestSyntax) ** 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 tidak memiliki isi permintaan. ## Sintaks Respons ``` HTTP/1.1 200 Content-type: application/json { "areAllComponentsReturned": boolean, "arn": "string", "components": { "string" : { "areAllCompositeComponentsReturned": boolean, "areAllPropertiesReturned": boolean, "componentName": "string", "componentTypeId": "string", "compositeComponents": { "string" : { "componentName": "string", "componentPath": "string", "componentTypeId": "string", "definedIn": "string", "description": "string", "propertyGroups": { "string" : { "groupType": "string", "isInherited": boolean, "propertyNames": [ "string" ] } }, "status": { "error": { "code": "string", "message": "string" }, "state": "string" }, "syncSource": "string" } }, "definedIn": "string", "description": "string", "properties": { "string" : { "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 }, "value": { "booleanValue": boolean, "doubleValue": number, "expression": "string", "integerValue": number, "listValue": [ "DataValue" ], "longValue": number, "mapValue": { "string" : "DataValue" }, "relationshipValue": { "targetComponentName": "string", "targetEntityId": "string" }, "stringValue": "string" } } }, "propertyGroups": { "string" : { "groupType": "string", "isInherited": boolean, "propertyNames": [ "string" ] } }, "status": { "error": { "code": "string", "message": "string" }, "state": "string" }, "syncSource": "string" } }, "creationDateTime": number, "description": "string", "entityId": "string", "entityName": "string", "hasChildEntities": boolean, "parentEntityId": "string", "status": { "error": { "code": "string", "message": "string" }, "state": "string" }, "syncSource": "string", "updateDateTime": number, "workspaceId": "string" } ``` ## Elemen Respons Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200. Layanan mengembalikan data berikut dalam format JSON. ** [areAllComponentsReturned](#API_GetEntity_ResponseSyntax) ** Bendera ini mencatat apakah semua komponen dikembalikan dalam respons API. Jumlah maksimum komponen yang dikembalikan adalah 30. Jenis: Boolean ** [arn](#API_GetEntity_ResponseSyntax) ** ARN entitas. Tipe: String Batasan Panjang: Panjang minimum 20. Panjang maksimum 2048. Pola: `arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+` ** [components](#API_GetEntity_ResponseSyntax) ** Objek yang memetakan string ke komponen dalam entitas. Setiap string dalam pemetaan harus unik untuk objek ini. Jenis: String ke peta [ComponentResponse](API_ComponentResponse.md) objek Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 256. Pola Kunci: `[a-zA-Z_\-0-9]+` ** [creationDateTime](#API_GetEntity_ResponseSyntax) ** Tanggal dan waktu ketika entitas dibuat. Tipe: Timestamp ** [description](#API_GetEntity_ResponseSyntax) ** Deskripsi entitas. Tipe: String Batasan Panjang: Panjang minimum sebesar 0. Panjang maksimum 2048. Pola: `.*` ** [entityId](#API_GetEntity_ResponseSyntax) ** ID entitas. Tipe: 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]+` ** [entityName](#API_GetEntity_ResponseSyntax) ** Nama entitas. Tipe: String Batasan Panjang: Panjang minimum 1. Panjang maksimum 256. Pola: `[^\u0000-\u001F\u007F]+` ** [hasChildEntities](#API_GetEntity_ResponseSyntax) ** Nilai Boolean yang menentukan apakah entitas memiliki entitas anak terkait. Jenis: Boolean ** [parentEntityId](#API_GetEntity_ResponseSyntax) ** ID entitas induk untuk entitas ini. Tipe: String Batasan Panjang: Panjang minimum 1. Panjang maksimum 128. Pola: `\$ROOT|^[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]+` ** [status](#API_GetEntity_ResponseSyntax) ** Status entitas saat ini. Tipe: Objek [Status](API_Status.md) ** [syncSource](#API_GetEntity_ResponseSyntax) ** SyncSource dari pekerjaan sinkronisasi, jika entitas ini dibuat oleh pekerjaan sinkronisasi. Tipe: String Pola: `[a-zA-Z_0-9]+` ** [updateDateTime](#API_GetEntity_ResponseSyntax) ** Tanggal dan waktu ketika entitas terakhir diperbarui. Tipe: Timestamp ** [workspaceId](#API_GetEntity_ResponseSyntax) ** ID ruang kerja. Tipe: String Batasan Panjang: Panjang minimum 1. Panjang maksimum 128. Pola: `[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+` ## Kesalahan Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Jenis Kesalahan Umum](CommonErrors.md). ** InternalServerException ** Terjadi kesalahan tak terduga. Kode Status HTTP: 500 ** ResourceNotFoundException ** Sumber daya tidak ditemukan. Kode Status HTTP: 404 ** ServiceQuotaExceededException ** Kuota layanan terlampaui. Kode Status HTTP: 402 ** ThrottlingException ** Tarif melebihi batas. Kode Status HTTP: 429 ** ValidationException ** Gagal Kode Status HTTP: 400 ## Lihat Juga Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini: + [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/iottwinmaker-2021-11-29/GetEntity) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iottwinmaker-2021-11-29/GetEntity)