CreateDatasetFileMetas

Updated at:

Creates file metadata records for a dataset in batches.

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:CreateDatasetFileMetas

create

*All Resource

*

None None

Request syntax

POST /api/v1/datasets/{DatasetId}/datasetfilemetas HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

DatasetId

string

Yes

The dataset ID. For more information about how to obtain the dataset ID, see ListDatasets.

d-lfd60v0p****ujtsdx

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

WorkspaceId

string

Yes

The ID of the workspace to which the dataset belongs. For more information about how to obtain the workspace ID, see ListWorkspaces.

478**

DatasetVersion

string

Yes

The name of the dataset version.

v1

DatasetFileMetas

array

Yes

The list of file metadata.

DatasetFileMetaContentCreate

No

The details of the file metadata.

Response elements

Element

Type

Description

Example

object

The request result.

RequestId

string

The request ID.

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

Status

boolean

The status of the batch metadata creation. A value of true indicates that all metadata records are created successfully. If the value is false, check FailedDetails.

Valid values:

  • true :

    Success.

  • false :

    Failure.

true

FailedDetails

array

The list of file metadata records that failed to be created.

DatasetFileMetaResponse

The details of the file metadata records that failed to be created.

SucceedDetails

array

The list of file metadata records that are successfully created.

DatasetFileMetaResponse

The details of the file metadata records that are successfully created.

Examples

Success response

JSON format

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "Status": true,
  "FailedDetails": [
    {
      "DatasetFileMetaId": "07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6",
      "Result": "Not Found",
      "Uri": "oss://l*****-test/dataset/1653421.jpg"
    }
  ],
  "SucceedDetails": [
    {
      "DatasetFileMetaId": "07914c9534586e4e7aa6e9dbca5009082df*******8a0d857b33296c59bf6",
      "Result": "Not Found",
      "Uri": "oss://l*****-test/dataset/1653421.jpg"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.