GetDatasetFileMeta

Updated at:

Retrieves the metadata record of a specified file in a dataset.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

paidataset:GetDatasetFileMeta

get

*All Resource

*

None None

Request syntax

GET /api/v1/datasets/{DatasetId}/datasetfilemetas/{DatasetFileMetaId} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

DatasetId

string

Yes

The dataset ID. For more information, see ListDatasets.

d-rbvg5wz****c9ks92

DatasetFileMetaId

string

Yes

The ID of the dataset file metadata.

07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6

Request parameters

Parameter

Type

Required

Description

Example

DatasetVersion

string

No

The name of the dataset version.

v1

WorkspaceId

string

No

The workspace ID. For more information, see ListWorkspaces.

1234

Response elements

Element

Type

Description

Example

object

The request result.

RequestId

string

The request ID.

5A14FA81-DD4E-******-6343FE44B941

DatasetFileMeta DatasetFileMetaContentGet

The details of the dataset file metadata.

DatasetVersion

string

The name of the dataset version.

v1

DatasetId

string

The dataset ID.

d-rbvg5wz****c9ks92

WorkspaceId

string

The workspace ID.

1234

Examples

Success response

JSON format

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "DatasetFileMeta": {
    "FileName": "00001.jpeg",
    "Uri": "oss://*****-test/dataset/1653421.jpg\nnas://0e25d***dff/dataset/1653421.jpg\n",
    "Comment": "The first image file in the dataset.",
    "FileCreateTime": "2025-01-12T14:36:01Z",
    "FileUpdateTime": "2025-01-12T14:36:01Z",
    "FileFingerPrint": "D41D8CD98F*****E9800998ECF8\n",
    "DataSize": 10000,
    "FileType": "image",
    "ContentType": "image/png",
    "MetaAttributes": "{\n    \"ImageHeight\": 1080,\n    \"ImageWidth\": 1920\n}",
    "Tags": "{\n    \"ai\":\n    [\n        \"Lane line\",\n        \"Water horse\",\n        \"Sunny day\"\n    ],\n    \"user\":\n    [\n        \"Everett\",\n        \"Intelligent driving Dataset 1\",\n        \"Cloudy day\"\n    ],\n    \"user-delete-ai-tags\":\n    [\n        \"Sunny day\"\n    ]\n}",
    "DatasetFileMetaId": "07914c9534586e4e7aa6e9dbca5009082df******fd8a0d857b33296c59bf6\n",
    "FileDir": "icp_certificate_card/icp/1577179298694813/1716429710367",
    "TagUpdateTime": "2021-01-12T14:36:01.000Z",
    "SemanticIndexJobId": "dsjob-klfwtjtov*****scvt3",
    "SemanticIndexUpdateTime": "2021-01-12T14:36:01.000Z",
    "Status": ""
  },
  "DatasetVersion": "v1",
  "DatasetId": "d-rbvg5wz****c9ks92",
  "WorkspaceId": "1234"
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.