コレクション内のエンティティを照会します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| CollectionQualifiedName |
string |
必須 |
コレクションの一意な識別子です。 |
album.12345 |
| EntityType |
string |
任意 |
エンティティの種類です。 たとえば、このパラメーターに maxcompute-table を指定した場合、対象のエンティティは MaxCompute テーブルになります。 |
maxcompute-table |
| Keyword |
string |
任意 |
検索キーワードです。 |
test |
| NextToken |
string |
任意 |
次のリクエストで使用するページネーショントークンです。これにより、新しいページの結果を取得できます。 |
12222 |
| PageSize |
integer |
任意 |
1 ページあたりの表示件数です。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
OpenApiMetaResultModel |
||
| Data |
object |
レスポンスパラメーターです。 |
|
| NextToken |
string |
ページネーショントークンです。これを使用して、次のリクエストで新しいページの結果を取得できます。 |
123344 |
| EntityList |
array |
エンティティ。 |
|
| Entity |
エンティティです。 |
||
| RequestId |
string |
リクエスト ID です。この ID を使用してログを特定し、問題のトラブルシューティングを行えます。 |
E25887B7-579C-54A5-9C4F-83A0DE367DD |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true：リクエストが成功しました。 false：リクエストが失敗しました。 |
true |
| ErrorCode |
string |
エラーコードです。 |
Invalid.Collection.NotExists |
| ErrorMessage |
string |
エラーメッセージです。 |
The specified parameters are invalid. |
| HttpStatusCode |
integer |
HTTP ステータスコードです。 |
200 |
例
成功レスポンス
JSONJSON
{
"Data": {
"NextToken": "123344",
"EntityList": [
{
"QualifiedName": "maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23",
"TenantId": 12345,
"EntityContent": {
"test": "test",
"test2": 1
}
}
]
},
"RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367DD",
"Success": true,
"ErrorCode": "Invalid.Collection.NotExists",
"ErrorMessage": "The specified parameters are invalid.",
"HttpStatusCode": 200
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。