Update IMM Dataset Metadata with the UpdateDataset API - IMM

Updates the information for a dataset.

Operation description

Before you use this API, review the billing methods and pricing for Intelligent Media Management.
Make sure that the dataset exists before you update its information. To create a dataset, see the request parameter descriptions.
When you update dataset information, specify only the fields that you want to change. Fields that you leave blank remain unchanged.
Dataset updates take up to 5 minutes to take effect.

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

update

*Dataset

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name. For more information, see Create a project.	test-project
DatasetName	string	Yes	The dataset name. For more information, see Create a dataset.	test-dataset
Description	string	No	The dataset description.	immtest
TemplateId	string	No	The workflow template ID. For more information, see Workflow templates and operators.	Official:ImageManagement
DatasetMaxBindCount	integer	No	The maximum number of bindings per dataset. Valid values: 1 to 10.	10
DatasetMaxFileCount	integer	No	The maximum number of files in each dataset. Valid values: 1 to 100,000,000.	100000000
DatasetMaxEntityCount	integer	No	The maximum number of metadata entities (including data files, file relationships, and clustering groups) in each dataset. Maximum value: 2^63-1. Note This is a reserved parameter and has no actual limit in use.	10000000000
DatasetMaxRelationCount	integer	No	The maximum number of metadata relationships in each dataset. Maximum value: 2^63-1. Note This is a reserved parameter and has no actual limit in use.	100000000000
DatasetMaxTotalFileSize	integer	No	The maximum total size of files in each dataset, in bytes. If this limit is exceeded, you cannot add more indexes. Maximum value: 2^63-1.	90000000000000000
WorkflowParameters	array	No	Invalid parameter.
	WorkflowParameter	No	Invalid parameter.
DatasetConfig	DatasetConfig	No	The dataset configuration.

Response elements

Element	Type	Description	Example
	object	The response structure.
RequestId	string	The request ID.	45234D4A-A3E3-4B23-AACA-8D897514****
Dataset	Dataset	The dataset.

Examples

Success response

JSON format

{
  "RequestId": "45234D4A-A3E3-4B23-AACA-8D897514****",
  "Dataset": {
    "ProjectName": "",
    "DatasetName": "",
    "TemplateId": "",
    "CreateTime": "",
    "UpdateTime": "",
    "Description": "",
    "DatasetMaxBindCount": 0,
    "DatasetMaxFileCount": 0,
    "DatasetMaxEntityCount": 0,
    "DatasetMaxRelationCount": 0,
    "DatasetMaxTotalFileSize": 0,
    "BindCount": 0,
    "FileCount": 0,
    "TotalFileSize": 0,
    "ClusterType": "",
    "SmartClusterTaskStatus": {
      "Status": "Succeeded",
      "LastSucceededTime": "2024-06-29T14:50:13.011643661+08:00",
      "StartTime": "2024-06-29T14:50:13.011643661+08:00"
    },
    "WorkflowParameters": [
      {
        "Value": "",
        "Name": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.