Call GetConfig API to Retrieve Workspace Configuration - Platform for AI

Retrieves the configurations of 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:GetConfig

get

*All Resource

*

None

Request syntax

GET /api/v1/workspaces/{WorkspaceId}/config HTTP/1.1

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
CategoryName	string	No	The classification of the configuration item. The following classifications are supported: CommonResourceConfig: common resource configurations DLCAutoRecycle: automatic DLC resource recycling DLCPriorityConfig: DLC priority settings DSWPriorityConfig: DSW priority settings QuotaMaximumDuration: the maximum runtime of a DLC task for a quota CommonTagConfig: tag settings	CommonResourceConfig
ConfigKey	string	No	The key of the configuration item. The following keys are supported: tempStoragePath: the temporary storage path. This key applies only when CategoryName is set to CommonResourceConfig. isAutoRecycle: the automatic recycling configuration. This key applies only when CategoryName is set to DLCAutoRecycle. priorityConfig: the priority configuration. This key applies only when CategoryName is set to DLCPriorityConfig or DSWPriorityConfig. quotaMaximumDuration: the maximum runtime of a DLC task for a quota. This key applies only when CategoryName is set to QuotaMaximumDuration. predefinedTags: the predefined tags for the workspace. Resources that you create must have tags.	tempStoragePath
Verbose	string	No	The value of the configuration item.	oss://***

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A******C83E
WorkspaceId	string	The workspace ID.	1234******2
ConfigKey	string	The key of the configuration item. The following keys are supported: tempStoragePath: the temporary storage path. This key applies only when CategoryName is CommonResourceConfig. isAutoRecycle: the automatic recycling configuration. This key applies only when CategoryName is DLCAutoRecycle. priorityConfig: the priority configuration. This key applies only when CategoryName is DLCPriorityConfig or DSWPriorityConfig. quotaMaximumDuration: the maximum runtime of a DLC task for a quota. This key applies only when CategoryName is QuotaMaximumDuration. predefinedTags: the predefined tags for the workspace. Resources that you create must have tags.	tempStoragePath
ConfigValue	string	The value of the configuration item.	oss://***
CategoryName	string	The classification of the configuration item. The following classifications are supported: CommonResourceConfig: common resource configurations DLCAutoRecycle: automatic DLC resource recycling DLCPriorityConfig: DLC priority settings DSWPriorityConfig: DSW priority settings QuotaMaximumDuration: the maximum runtime of a DLC task for a quota CommonTagConfig: tag settings	CommonResourceConfig
Labels	array<object>	The list of tags for the configuration item.
	object	The tag of the configuration item.
Key	string	The key of the tag.	key1
Value	string	The value of the tag.	value1
GmtCreateTime	string
GmtModifiedTime	string

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A******C83E",
  "WorkspaceId": "1234******2\n",
  "ConfigKey": "tempStoragePath",
  "ConfigValue": "oss://***",
  "CategoryName": "CommonResourceConfig",
  "Labels": [
    {
      "Key": "key1",
      "Value": "value1"
    }
  ],
  "GmtCreateTime": "",
  "GmtModifiedTime": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.