CreateBinding-Intelligent Media Management(IMM)-阿里云帮助中心

Operation description

Make sure that you fully understand the billing methods and pricing of Intelligent Media Management (IMM) before you call this operation.

Important Asynchronous tasks do not guarantee immediate completion.

Before you create a binding relationship, make sure that you have created the corresponding project and dataset.

Note

Data binding uses the workflow template specified when the project or dataset is created to process files.

After the binding relationship is created, IMM first performs a full scan on the existing data in the OSS bucket and extracts file metadata for indexing. After the full scan is complete, IMM continues to perform near real-time incremental tracking, extraction, and indexing for new files in the OSS bucket. After files are indexed in this way, you can use file query operations such as SimpleQuery to query, manage, and collect statistics on the files.

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. For more information about how to obtain the project name, see Create a project.	test-project
DatasetName	string	No	The name of the dataset. For more information about how to obtain the dataset name, see Create a dataset.	test-dataset
URI	string	Yes	The URI of the OSS bucket bound to the dataset. The URI of the OSS bucket is in the format of oss://${Bucket}, where `${Bucket}` is 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 struct.
Binding	Binding	The binding information.
RequestId	string	The request ID.	5F74C5C9-5AC0-49F9-914D-E01589D3****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.