SearchFile - Drive and Photo Service: Central de Documentação do Alibaba Cloud

Pesquisa arquivos.

Descrição da operação

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST /v2/file/search HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
domain_id	string	Sim
body	object	Não	O corpo da solicitação.
drive_id	string	Não	O ID da unidade.	1
query	string	Sim	As condições de pesquisa. Há suporte a pesquisas aproximadas com base no nome do arquivo ou no nome do diretório. O valor deste parâmetro pode ter até 4.096 caracteres.	name="123"
order_by	string	Não	O campo pelo qual classificar as entradas retornadas. Valor padrão: created_at. Valores válidos: * created_at: classifica as entradas por hora de criação. * updated_at: classifica as entradas por hora de atualização. * size: classifica as entradas por tamanho de arquivo. * name: classifica as entradas por nome de arquivo. A ordem na qual você deseja classificar as entradas retornadas. Valores válidos: * ASC: ordem crescente * DESC: ordem decrescente Você deve especificar este parâmetro no formato . Separe vários campos com vírgulas (,). Um campo precedente tem prioridade maior que um campo seguinte. Exemplos: * Se você deseja classificar as entradas por nome de arquivo em ordem crescente, defina este parâmetro como "name ASC". * Se você deseja classificar as entradas por hora de criação em ordem decrescente, defina este parâmetro como "created_at DESC". * Se você deseja classificar as entradas por hora de criação em ordem decrescente e classificar as entradas por nome de arquivo em ordem crescente em caso de mesma hora de criação, defina este parâmetro como "created_at DESC,name ASC".	name ASC
limit	integer	Não	O número máximo de entradas a serem retornadas. Valores válidos: 1 a 100. O número de entradas retornadas deve ser menor ou igual ao valor deste parâmetro.	50
marker	string	Não	O nome da entrada após a qual a lista começa. As entradas cujos nomes são alfabeticamente posteriores ao valor deste parâmetro são retornadas. Se você não especificar este parâmetro, todas as entradas serão retornadas. Este parâmetro é deixado vazio por padrão.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
return_total_count	boolean	Não	Especifica se deve retornar o número total de arquivos recuperados.	true
recursive	boolean	Não	Especifica se deve realizar uma pesquisa recursiva em uma pasta especificada ao definir parent_file_id no parâmetro de consulta.	true
thumbnail_processes	object	Não	As configurações de miniatura. Até cinco miniaturas podem ser retornadas por vez. O valor contém pares chave-valor. Você pode personalizar as chaves. A URL de uma miniatura é retornada com base na chave.
	ImageProcess	Não	As regras usadas para gerar as miniaturas de imagens, vídeos e documentos.
fields	string	Não	O campo usado para retornar informações adicionais sobre os arquivos. Valores válidos: * dir_size: retorna as estatísticas de cada subpasta na resposta. * id_path: retorna o valor id_path de cada item filho na resposta. * name_path: retorna o valor name_path de cada item filho na resposta. Você pode especificar vários campos separando-os com vírgulas (,). Exemplo: "id_path,name_path,dir_size".	id_path,name_path

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da Resposta.
items	array	Lista de informações de arquivos.
	File	Informações do arquivo.
next_marker	string	O identificador do recurso inicial na próxima página. Este valor fica vazio na última página.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
total_count	integer	O número total de arquivos que correspondem à pesquisa.	1022

Exemplos

Resposta de sucesso

JSON formato

{
  "items": [
    {
      "domain_id": "bj1",
      "drive_id": "1",
      "file_id": "5d79206586bb5dd69fb34c349282718146c55da7",
      "name": "1.mov",
      "type": "file",
      "content_type": "application/json",
      "created_at": "2019-08-20T06:51:27.292Z",
      "updated_at": "2019-08-20T06:51:27.292Z",
      "description": "image file",
      "trashed_at": "2019-08-20T06:51:27.292Z",
      "file_extension": "txt",
      "hidden": false,
      "size": 1024,
      "starred": false,
      "status": "available",
      "labels": [
        "[\"label1:1\", \"label2:2\"]"
      ],
      "upload_id": "C9DCFE5A82644AC7A02DB74C30C934A6",
      "parent_file_id": "3d5b846942cf94fa72324c8a4bda34e81da635a",
      "crc64_hash": "3574582125365864471",
      "content_hash": "EA4942AA8761213890A5C386F88E6464D2C31CA3",
      "content_hash_name": "sha1",
      "download_url": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
      "thumbnail": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
      "category": "image",
      "local_created_at": "2019-08-20T06:51:27.292Z",
      "local_modified_at": "2019-08-20T06:51:27.292Z",
      "revision_id": "5d5b846942cf94fa72324c14a4bda34e81da635d",
      "thumbnail_urls": {
        "key": "\"128X128\": \"https://url1\", \"800X800\": \"url2\""
      },
      "image_media_metadata": {
        "time": "2006-01-02T15:04:05.000Z07:00",
        "width": 1024,
        "height": 1024,
        "location": "30.185453,120.218522",
        "country": "China\n",
        "province": "Zhejiang\n",
        "city": "Hangzhou\n",
        "district": "Binjiang District\n",
        "township": "Xixing Street\n",
        "address_line": "Jiangling Road, Xixing Street, Binjiang District, Hangzhou, Zhejiang\n",
        "image_tags": [
          {
            "confidence": 0.98,
            "parent_name": "sport",
            "name": "basketball",
            "tag_level": 3,
            "source": "play basketball",
            "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
        }
      },
      "user_tags": {
        "key": "\"k1\":\"v1\", \"k2\",\"v2\""
      },
      "video_media_metadata": {
        "width": 1920,
        "height": 1080,
        "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"
          }
        ]
      },
      "id_path": "id1/id2",
      "name_path": "root/f1/f2",
      "dir_size_info": {
        "dir_count": 1,
        "file_count": 10
      },
      "action_list": [
        ""
      ],
      "auto_delete_left_sec": 0
    }
  ],
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "total_count": 1022
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.