ファイルおよびフォルダの一覧を照会します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/file/list HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストボディ。 |
|
| share_id |
string |
任意 |
共有 ID。ファイルを共有する場合は、リクエストに x-share-token ヘッダーを含めて認証を行い、 |
7JQX1FswpQ8 |
| drive_id |
string |
任意 |
ドライブ ID。 |
1 |
| parent_file_id |
string |
必須 |
親フォルダの ID。親フォルダがルートディレクトリの場合、このパラメーターを root に設定します。 |
root |
| limit |
integer |
任意 |
返される結果の最大数。有効値：1～100。 返されるエントリ数は、このパラメーターの値以下である必要があります。 |
50 |
| marker |
string |
任意 |
リストの開始位置となるエントリの名前。このパラメーターの値よりアルファベット順で後ろにあるエントリが返されます。このパラメーターを指定しない場合、すべてのエントリが返されます。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| status |
string |
任意 |
返されるファイルの状態。有効値： available：通常のファイルのみを返します。 uploading：アップロード中のファイルのみを返します。 デフォルトでは、available 状態のファイルのみが返されます。 列挙値:
|
available |
| order_by |
string |
任意 |
ソートフィールド。有効値： created_at：作成時刻でエントリをソートします。 updated_at：更新時刻でエントリをソートします。 size：ファイルサイズでエントリをソートします。 name：ファイル名でエントリをソートします。 デフォルト値：created_at。 列挙値：
列挙値:
|
updated_at |
| order_direction |
string |
任意 |
ソート方向。有効値： ASC：昇順 DESC：降順 デフォルト値：ASC。 列挙値:
|
ASC |
| category |
string |
任意 |
ファイルカテゴリ。有効値： app：インストールパッケージ zip：圧縮パッケージ image：イメージ doc：ドキュメント video：動画 audio：音声 others：その他 デフォルトでは、すべてのカテゴリのファイルが返されます。 列挙値:
|
image |
| type |
string |
任意 |
ファイルタイプ。有効値： file：ファイルのみを返します。 folder：フォルダのみを返します。 デフォルトでは、すべてのタイプのファイルが返されます。 列挙値:
|
file |
| fields |
string |
任意 |
子件名に関する追加情報を返すために使用されるフィールド。有効値：
複数のフィールドをカンマ (,) で区切って指定できます。例： "url,dir_size,user_tags"。 |
* |
| thumbnail_processes |
object |
任意 |
サムネイル構成。一度に最大 5 つのサムネイルを返すことができます。値にはキーと値のペアが含まれます。キーはカスタマイズ可能です。サムネイルの URL はキーに基づいて返されます。 |
|
| ImageProcess |
任意 |
画像、動画、ドキュメントのサムネイルを生成するために使用されるルール。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| items |
array |
照会されたファイル。 |
|
| File |
照会されたファイル。 |
||
| next_marker |
string |
ページネーショントークン。次のリクエストで新しいページの結果を取得するために使用できます。next_marker が空の場合、次のページは存在しません。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
例
成功レスポンス
JSONJSON
{
"items": [
{
"domain_id": "",
"drive_id": "",
"file_id": "",
"name": "",
"type": "",
"content_type": "",
"created_at": "",
"updated_at": "",
"description": "",
"trashed_at": "",
"file_extension": "",
"mime_type": "",
"mime_extension": "",
"hidden": true,
"size": 0,
"starred": true,
"status": "",
"user_meta": "",
"labels": [
""
],
"upload_id": "",
"parent_file_id": "",
"crc64_hash": "",
"content_hash": "",
"content_hash_name": "",
"download_url": "",
"thumbnail": "",
"category": "",
"local_created_at": "",
"local_modified_at": "",
"revision_id": "",
"investigation_info": {
"status": 0,
"suggestion": ""
},
"thumbnail_urls": {
"key": ""
},
"image_media_metadata": {
"time": "2006-01-02T15:04:05.000Z07:00",
"width": 1920,
"height": 1080,
"location": "30.185453,120.218522",
"country": "中国",
"province": "浙江省",
"city": "杭州市",
"district": "滨江区",
"township": "西兴街道",
"address_line": "浙江省杭州市滨江区西兴街道江陵路",
"image_tags": [
{
"confidence": 0.98,
"parent_name": "运动",
"name": "篮球",
"tag_level": 3,
"source": "一起打篮球",
"centric_score": 0.877
}
],
"faces": "[{\"FaceId\":\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\",\"GroupId\":\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\",\"FaceConfidence\":0.999,\"Age\":13,\"AgeConfidence\":4,\"Gender\":\"female\",\"GenderConfidence\":1,\"Emotion\":\"none\",\"EmotionConfidence\":0.672,\"FaceAttributes\":{\"Mask\":\"none\",\"MaskConfidence\":0.894,\"Beard\":\"none\",\"BeardConfidence\":0.997,\"Glasses\":\"none\",\"GlassesConfidence\":0.999,\"Mouth\":\"close\",\"MouthConfidence\":0.937,\"Hat\":\"none\",\"HatConfidence\":0.998,\"HeadPose\":{\"Pitch\":10.684,\"Roll\":-10.707,\"Yaw\":-20.094},\"FaceBoundary\":{\"Width\":457,\"Height\":687,\"Top\":1324,\"Left\":1356}}}]",
"faces_thumbnail": [
{
"face_id": "a9a66a86-73dd-4c95-8b79-1d8a49db5226",
"face_group_id": "Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0",
"face_thumbnail": "https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2"
}
],
"exif": "{\"Compression\":{\"value\":\"6\"},\"DateTime\":{\"value\":\"2020:08:19 17:11:11\"}}",
"image_quality": {
"overall_score": 0.736
}
},
"ex_fields_info": {
"key": ""
},
"content_uri": "",
"streams_info": {
"key": {
"crc64_hash": "",
"size": 0,
"content_hash": "",
"content_hash_name": "",
"download_url": "",
"url": "",
"thumbnail": ""
}
},
"user_tags": {
"key": ""
},
"revision_version": 0,
"video_media_metadata": {
"time": "2006-01-02T15:04:05.000Z07:00",
"width": 1920,
"height": 1080,
"location": "30.185453,120.218522",
"country": "中国",
"province": "浙江省",
"city": "杭州市",
"district": "滨江区",
"township": "西兴街道",
"address_line": "浙江省杭州市滨江区西兴街道江陵路",
"video_media_video_stream": [
{
"duration": "22.88",
"bitrate": "108420",
"code_name": "h264",
"frame_count": "90"
}
],
"video_media_audio_stream": [
{
"duration": "7704.573000",
"bit_rate": "129280",
"code_name": "aac"
}
]
},
"punish_flag": 0,
"id_path": "",
"name_path": "",
"creator_type": "",
"creator_id": "",
"creator_name": "",
"last_modifier_type": "",
"last_modifier_id": "",
"last_modifier_name": "",
"dir_size_info": {
"dir_count": 0,
"file_count": 0
},
"trashed": true,
"action_list": [
""
],
"location": "",
"semantic_result": {
"semantic_similarity": 0.879,
"document_contents": [
{
"element_contents": [
{
"type": "text",
"content": "文本片段",
"url": "http://aliyun.com",
"time_range": [
0
]
}
]
}
],
"scene_contents": [
{
"time_range": [
0
],
"key_frames": [
{
"frame_time": 1000,
"thumbnail_url": "http://aliyun.com"
}
],
"thumbnail_url": "http://aliyun.com"
}
]
},
"sync_flag": true,
"sync_device_flag": true,
"origin_parent_file_id": "",
"url": "",
"custom_field_1": "",
"custom_field_2": "",
"auto_delete_left_sec": 0
}
],
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。