Use CreateBinding to bind a dataset to an OSS bucket for automatic data sync and indexing - Intelligent Media Management

Operation description

Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****

Note

Asynchronous processing does not guarantee timely task completion.

Before you create a binding, make sure that the project and the dataset that you want to use exist.

For information about how to create a project, see CreateProject.
For information about how to create a dataset, see CreateDataset.

Note

The CreateBinding operation works by using the workflow template that is specified when you created the project or dataset.

After you create a binding between a dataset and an OSS bucket, IMM scans the existing objects in the bucket and extracts metadata based on the scanning result. Then, IMM creates an index from the extracted metadata. If new objects are uploaded to the OSS bucket, IMM tracks and scans the objects and updates the index. For objects whose metadata index is created by calling this operation, you can call query operations, such as SimpleQuery, to query objects, manage objects, and collect statistics on objects.

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

create

*Dataset

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. You can obtain the name of the project from the response of the CreateProject operation.	test-project
DatasetName	string	Yes	The name of the dataset. You can obtain the name of the dataset from the response of the CreateDataset operation.	test-dataset
URI	string	Yes	The URI of the OSS bucket to which you bind the dataset. Specify the value in the oss://${Bucket} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project.	oss://test-bucket

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	5F74C5C9-5AC0-49F9-914D-E01589D3****
Binding	Binding	The information about the binding.

Examples

Success response

JSON format

{
  "RequestId": "5F74C5C9-5AC0-49F9-914D-E01589D3****",
  "Binding": {
    "ProjectName": "immtest",
    "DatasetName": "dataset001",
    "URI": "oss://examplebucket",
    "State": "Running",
    "Phase": "FullScanning",
    "CreateTime": "2021-06-29T14:50:13.011643661+08:00",
    "UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
    "Reason": "暂停使用"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.