Batch Associating or Disassociating Data Integration Resources With a Workspace_Resource Management API_Manager API_API Reference

Function

This API is used to batch associate or disassociate data integration resources with a workspace. The action field in workspaces is used to distinguish the operation type. band indicates association, and remove indicates disassociation.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/{instance_id}/migration/batch-bind-workspace

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Project ID and Account ID.
instance_id	Yes	String	DataArts Studio instance ID. For details about how to obtain it, see Instance ID and Workspace ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when Token Authentication is used. You can obtain it from the X-Subject-Token header in the response of the "Obtaining a User Token" API provided by IAM.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
banding_resource_list	Yes	Array of MigrationBindResource objects	List of resources to be associated or disassociated.

**Table 4** MigrationBindResource
Parameter	Mandatory	Type	Description
resource_id	Yes	String	Resource ID.
resource_name	Yes	String	Resource name.
workspaces	Yes	Array of MigrationBindWorkspace objects	List of workspaces associated with the resource. A maximum of 100 workspaces are supported.

**Table 5** MigrationBindWorkspace
Parameter	Mandatory	Type	Description
id	Yes	String	Workspace ID.
action	Yes	String	Operation type. Options: band: Associates the resource with the workspace. remove: Disassociates the resource from the workspace.

Response Parameters

Status code: 200

The batch association or disassociation of data integration resources with the workspace is successful.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Returned error information.
error_code	String	Returned error code.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Returned error information.
error_code	String	Returned error code.

Example Requests

{
  "banding_resource_list" : [ {
    "resource_id" : "b1bb2f10-705b-4124-91b7-b890450cc094",
    "resource_name" : "migration_60071039_0618",
    "workspaces" : [ {
      "id" : "48a90d06914342709b3d7e24ae17de6f",
      "action" : "band"
    } ]
  } ]
}

Example Responses

Status code: 400

Bad request.

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

Status code: 500

Internal server error.

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

Status Codes

Status Code	Description
200	The batch association or disassociation of data integration resources with the workspace is successful.
400	Bad request.
500	Internal server error.

Batch Associating or Disassociating Data Integration Resources With a Workspace