Automate PAI Workspace Config Updates via UpdateConfigs API - Platform For AI

Updates or creates workspace configurations in batches.

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

update

*All Resource

*

None

Request syntax

PUT /api/v1/workspaces/{WorkspaceId}/configs HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID.	83***

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
Configs	array<object>	No	A list of workspace configurations to update or add.
	array<object>	No	A workspace configuration to update or add.
ConfigKey	string	No	The key of the configuration item. The following keys are supported: tempStoragePath: The path for temporary storage. This key is valid only when CategoryName is set to CommonResourceConfig. isAutoRecycle: The configuration for automatic resource recycling. This key is valid only when CategoryName is set to DLCAutoRecycle. priorityConfig: The priority configuration. This key is valid only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig. quotaMaximumDuration: The maximum runtime configuration for a DLC job within a quota. This key is valid only when CategoryName is set to QuotaMaximumDuration. predefinedTags: The predefined tags for the workspace. Created resources must have these tags.	tempStoragePath
ConfigValue	string	No	The value of the configuration item. If ConfigKey is set to predefinedTags, the format of ConfigValue is [{"Type":"Tag","Key":"Key1","Value":"{\"Products\":\"DLC,DSW,EAS\",\"Values\":\"value1,value2,value3\"}"}]. The Products field specifies which products use the predefined tags.	oss://test/s/
CategoryName	string	No	The category of the configuration item. The following categories are supported: CommonResourceConfig: General resource configuration. DLCAutoRecycle: DLC automatic recycling. DLCPriorityConfig: DLC priority settings. DSWPriorityConfig: DSW priority settings. QuotaMaximumDuration: Configuration for the maximum runtime of a DLC job within a quota. CommonTagConfig: Tag settings.	CommonResourceConfig
Labels	array<object>	No	A list of tags for the configuration item.
	object	No	A tag for the configuration item.
Key	string	No	The key of the tag.	key1
Value	string	No	The value of the tag.	value1

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A******C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A******C83E\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.