ListConfigs-阿里云帮助中心

Lists the configurations for 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:ListConfigs

list

*All Resource

*

None

Request syntax

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

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
CategoryName	string	No	The category of the configuration item. The following categories are supported: CommonResourceConfig: The common resource configuration. DLCAutoRecycle: The automatic recycling configuration for DLC. DLCPriorityConfig: The priority configuration for DLC. DSWPriorityConfig: The priority configuration for DSW. QuotaMaximumDuration: The configuration for the maximum runtime of a DLC task in a quota. CommonTagConfig: The label configuration.	CommonResourceConfig
ConfigKeys	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 automatic recycling configuration. 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 configuration for the maximum runtime of a DLC task in a quota. This key is valid only when CategoryName is set to QuotaMaximumDuration. predefinedTags: The predefined labels for the workspace. Resources that you create must have these labels.	tempStoragePath
Labels	string	No	The labels to use as filter conditions. Separate multiple labels with commas. A logical AND operation is performed on these labels.	key1=value1,key2=value2
Verbose	string	No	Specifies whether to return label information. true: Returns label information. false: Does not return label information.	true

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A******C83E
Configs	array<object>	The list of configuration items.
	array<object>	The configuration item.
ConfigKey	string	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 automatic recycling configuration. 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 configuration for the maximum runtime of a DLC task in a quota. This key is valid only when CategoryName is set to QuotaMaximumDuration. predefinedTags: The predefined labels for the workspace. Resources that you create must have these labels.	tempTableLifecycle
ConfigValue	string	The value of the configuration item.	oss://***
Labels	array<object>	The list of labels for the configuration item.
	object	The label of the configuration item.
Key	string	The key of the label.	key1
Value	string	The value of the label.	value1
GmtCreateTime	string
GmtModifiedTime	string
TotalCount	integer	The total number of entries returned.	15

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A******C83E\n",
  "Configs": [
    {
      "ConfigKey": "tempTableLifecycle",
      "ConfigValue": "oss://***\n",
      "Labels": [
        {
          "Key": "key1",
          "Value": "value1\n"
        }
      ],
      "GmtCreateTime": "",
      "GmtModifiedTime": ""
    }
  ],
  "TotalCount": 15
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.