Add Resource References to PAI Workspace via API to Enable Cross-Service Access - Platform For AI

Adds a resource reference to a workspace.

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

paiworkspace:CreateWorkspaceResource

*All Resource

*

None

Request syntax

POST /api/v1/workspaces/{WorkspaceId}/resources HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the workspace. For more information, see ListWorkspaces.	123

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request struct.
Resources	array<object>	Yes	The list of resources.
	array<object>	Yes	The resource information.
Name	string	Yes	The resource name. The name must meet the following requirements: It must be 3 to 28 characters in length. It must start with a letter and can contain only letters, digits, and underscores (_). It must be unique within the same region. If Option is set to Attach and ResourceType is set to MaxCompute, this parameter specifies the project name.	ResourceName
ProductType	string	No	This field is deprecated and will be removed. Use the ResourceType field instead.	MaxCompute
EnvType	string	Yes	The environment type. Valid values: dev: development environment prod: production environment	prod
WorkspaceId	string	Yes	The ID of the workspace to which the resource belongs. For more information, see ListWorkspaces.	123
IsDefault	boolean	No	Specifies whether the resource is the default resource. Each resource type has one default resource. Valid values: false (default): The resource is not the default resource. true: The resource is the default resource.	false
Quotas	array<object>	No	The list of resource quotas. Currently, only MaxCompute resources have resource quotas.
	object	No	The details of the resource quota.
Id	string	Yes	The ID of the resource quota. For more information, see ListQuotas.	232892******92912
Spec	object	No	The resource specifications in the JSON format.	对于MaxCompute {"Endpoint": "odps.alibaba-inc.com", "Project": "mignshi"}
GroupName	string	No	The name of the resource group. The name must be unique within an Alibaba Cloud account. This parameter is required for MaxCompute, ECS, Lingjun, ACS, and Flink resources.	groupName
ResourceType	string	No	The resource type. Valid values: MaxCompute: MaxCompute resources ECS: general computing resources Lingjun: Lingjun resources ACS: ACS computing resources FLINK: Flink resources	MaxCompute
Labels	array<object>	No	An array of resource tags.
	object	No	The resource tag.
Key	string	No	The key of the tag.	system.support.eas
Value	string	No	The value of the tag.	true
Option	string	No	The creation behavior. Valid values: CreateAndAttach: Creates a resource and attaches it to the workspace. Attach: Attaches a resource to the workspace. If you set this parameter to Attach, you must specify the Name, ResourceType, GroupName, and EnvType parameters. Note MaxCompute resources only support the Attach option.	CreateAndAttach

Response elements

Element	Type	Description	Example
	object	The returned struct.
RequestId	string	The request ID.	1e195c5116124202371861018d5bde
Resources	array<object>	A collection of resources.
	object	The resource details.
Id	string	The resource ID.	1234
TotalCount	integer	The total number of resources.	1

Examples

Success response

JSON format

{
  "RequestId": "1e195c5116124202371861018d5bde",
  "Resources": [
    {
      "Id": "1234"
    }
  ],
  "TotalCount": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.