ListConfigs - 获取工作空间配置列表

获取工作空间配置列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paiworkspace:ListConfigslist
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
WorkspaceIdstring

工作空间 ID

87***
CategoryNamestring

配置项的分类。目前支持如下分类

  • CommonResourceConfig 通用资源配置
  • DLCAutoRecycle DLC 自动回收
  • DLCPriorityConfig DLC 优先级设置
  • DSWPriorityConfig DSW 优先级设置
  • QuotaMaximumDuration Quota 的 DLC 任务最大运行时长配置
  • CommonTagConfig 标签设置
CommonResourceConfig
ConfigKeysstring

配置项的键。目前支持如下键:

  • tempStoragePath 临时存储路径,只有 CategoryName 为 CommonResourceConfig 时才允许使用该 ConfigKey
  • isAutoRecycle 自动回收配置,只有 CategoryName 为 DLCAutoRecycle 时才允许使用该 ConfigKey
  • priorityConfig 优先级配置,只有 CategoryName 为 DLCPriorityConfig 或者 DSWPriorityConfig 时才允许使用该 ConfigKey
  • quotaMaximumDuration Quota 的 DLC 任务最大运行时长配置,只有 CategoryName 为 QuotaMaximumDuration 时才允许使用该 ConfigKey
  • predefinedTags 工作空间预置标签,创建的资源必须带上标签
tempStoragePath
Labelsstring

标签作为过滤条件,多个条件用逗号分隔,这些条件之间是与的关系。

key1=value1,key2=value2
Verbosestring

是否展示 Label 信息

  • true:展示 Label 信息
  • false:不展示 Label 信息
true

返回参数

名称类型描述示例值
object

响应。

RequestIdstring

请求 ID

473469C7-AA6F-4DC5-B3DB-A******C83E
Configsarray<object>

配置项列表。

Configsobject

配置项。

ConfigKeystring

配置项的键。目前支持如下键:

  • tempStoragePath 临时存储路径,只有 CategoryName 为 CommonResourceConfig 时才允许使用该 ConfigKey
  • isAutoRecycle 自动回收配置,只有 CategoryName 为 DLCAutoRecycle 时才允许使用该 ConfigKey
  • priorityConfig 优先级配置,只有 CategoryName 为 DLCPriorityConfig 或者 DSWPriorityConfig 时才允许使用该 ConfigKey
  • quotaMaximumDuration Quota 的 DLC 任务最大运行时长配置,只有 CategoryName 为 QuotaMaximumDuration 时才允许使用该 ConfigKey
  • predefinedTags 工作空间预置标签,创建的资源必须带上标签
tempTableLifecycle
ConfigValuestring

配置值

oss://***
Labelsarray<object>

配置项的标签列表。

Labelsobject

配置项的标签。

Keystring

标签的键。

key1
Valuestring

标签的值。

value1
TotalCountlong

返回数量

15

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2025-06-05OpenAPI 返回结构发生变更查看变更详情