CreateDataset

Updated at:

Creates a dataset.

Operation description

  • Before calling this operation, make sure that you fully understand the billing methods and pricing of Intelligent Media Management.

  • The dataset name must be unique within a project.

  • The number of datasets that you can create is limited. You can call the GetProjcet operation to query the limit.

  • After creating a dataset, you can call the IndexFileMeta operation to create file metadata indexes for diversified data retrieval and statistics and intelligent management.

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

imm:CreateDataset

create

*Dataset

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

None None

Request parameters

Parameter

Type

Required

Description

Example

ProjectName

string

Yes

The name of the project. For more information about how to obtain the project name, see Create a project.

test-project

DatasetName

string

Yes

The name of the dataset. The name must be unique within a project. The name must meet the following requirements:

  • The name must be 1 to 128 characters in length.

  • The name can contain only letters, digits, hyphens (-), and underscores (_).

  • The name must start with a letter or an underscore (_).

dataset001

Description

string

No

The description of the dataset. The description must be 1 to 256 characters in length. Default value: empty.

immtest

TemplateId

string

No

The ID of the workflow template. For more information, see Workflow templates and operators. Default value: empty.

Official:ImageManagement

DatasetMaxBindCount

integer

No

The maximum number of bindings per dataset. Valid values: 1 to 10. Default value: 10.

10

DatasetMaxFileCount

integer

No

The maximum number of files per dataset. Valid values: 1 to 100000000. Default value: 100000000.

100000000

DatasetMaxEntityCount

integer

No

The maximum number of metadata entities per dataset. Default value: 10000000000.

10000000000

DatasetMaxRelationCount

integer

No

The maximum number of metadata relations per dataset. Default value: 100000000000.

100000000000

DatasetMaxTotalFileSize

integer

No

The maximum total size of files per dataset. If the limit is exceeded, no more indexes can be added. Default value: 90000000000000000. Unit: bytes.

90000000000000000

WorkflowParameters deprecated

array

No

Invalid parameter.

WorkflowParameter

No

Invalid parameter.

Response elements

Element

Type

Description

Example

object

The response struct.

Dataset Dataset

The dataset information.

RequestId

string

The request ID.

6D74B3A9-5AC0-49F9-914D-E01589D3****

Examples

Success response

JSON format

{
  "Dataset": {
    "ProjectName": "immtest",
    "DatasetName": "dataset001",
    "TemplateId": "DefaultId",
    "CreateTime": "2021-06-29T14:50:13.011643661+08:00",
    "UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
    "Description": "测试数据集",
    "DatasetMaxBindCount": 10,
    "DatasetMaxFileCount": 100000000,
    "DatasetMaxEntityCount": 10000000000,
    "DatasetMaxRelationCount": 100000000000,
    "DatasetMaxTotalFileSize": 90000000000000000,
    "BindCount": 2,
    "FileCount": 10,
    "TotalFileSize": 100000,
    "WorkflowParameters": [
      {
        "Name": "name",
        "Value": "value"
      }
    ]
  },
  "RequestId": "6D74B3A9-5AC0-49F9-914D-E01589D3****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.