ListWorkspaces - 工作空间列表 - 云原生数据仓库AnalyticDB

查询SaaS工作空间列表

接口说明

使用说明

本接口用于查看所有工作空间信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	工作空间所在地域 ID。	cn-hangzhou
NextToken	string	否	下一个查询开始 Token。	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	否	本次读取的最大数据量，默认值为 10。	50
PageSize	integer	否	每页记录数，取值说明： 20 50 100 默认值：20。	20
PageNumber	integer	否	当前页码。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
TotalRecordCount	integer	总记录数。	1
Items	array<object>	工作空间详情列表。
	array<object>	参数列表。
WorkspaceId	string	工作空间 ID。	gp-ws-wkb4fp3j9u79ha
WorkspaceName	string	工作空间名称。最大长度 50 不允许重复不允许特殊字符	anchashid8FocugQ.oxs.xaliyun.com/oxspopscand8FocugQ#
CreateTime	string	创建时间。	2021-10-09T04:54:08Z
Services	array<object>	工作空间内服务。
	object	工作空间内服务信息。
ServiceId	string	服务 ID。	agdb-xxxx
ServiceName	string	服务名字。	agdb-xxxx
ServiceType	string	服务类型，取值： memory drama	memory
Status	string	服务状态 creating 创建中 active 运行中	active
CreateTime	string	创建时间。	2026-03-09T02:26:48Z
Cu	string	计算资源	1
PayType	string	计费类型，取值如下： POSTPAY：按量付费 PREPAY：包年包月说明如果不填，则会默认为按量付费。包年包月计费模式下，一次性购买一年及以上时长时会有一定优惠，建议您按需选择计费类型。	POSTPAY
ExpireTime	string	到期时间。	2026-01-26T16:00:00Z
Plan	string	【已废弃】	deprecated
Apikeys	array<object>	工作空间 API KEY 列表
	array<object>
KeyId	string	API KEY 的 ID。	api-xxxx
KeyName	string	API KEY 的名字。	my-apikey
Description	string	描述信息。	my api key
KeyPrefix	string	API KEY 的前缀。	sk-xxxxxx
CreateTime	string	API KEY 的创建时间。	2026-03-09T02:26:48Z
AuthServices	array<object>	API KEY 已授权的服务。
	object
ServiceType	string	服务类型，取值： memory drama	drama
ServiceId	string	服务 ID。	agdb-eqxwj5tj5ojx
MaxResults	integer	本次读取的最大数据量，默认值为 10。	50
NextToken	string	下一个查询开始 Token。	caeba0bbb2be03f84eb48b699f0a****
PageNumber	integer	当前页码。	1
PageRecordCount	integer	当前页记录数。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "TotalRecordCount": 1,
  "Items": [
    {
      "WorkspaceId": "gp-ws-wkb4fp3j9u79ha",
      "WorkspaceName": "anchashid8FocugQ.oxs.xaliyun.com/oxspopscand8FocugQ#",
      "CreateTime": "2021-10-09T04:54:08Z",
      "Services": [
        {
          "ServiceId": "agdb-xxxx",
          "ServiceName": "agdb-xxxx",
          "ServiceType": "memory",
          "Status": "active",
          "CreateTime": "2026-03-09T02:26:48Z",
          "Cu": "1",
          "PayType": "POSTPAY",
          "ExpireTime": "2026-01-26T16:00:00Z",
          "Plan": "deprecated"
        }
      ],
      "Apikeys": [
        {
          "KeyId": "api-xxxx",
          "KeyName": "my-apikey",
          "Description": "my api key",
          "KeyPrefix": "sk-xxxxxx",
          "CreateTime": "2026-03-09T02:26:48Z",
          "AuthServices": [
            {
              "ServiceType": "drama",
              "ServiceId": "agdb-eqxwj5tj5ojx"
            }
          ]
        }
      ]
    }
  ],
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "PageNumber": 1,
  "PageRecordCount": 1
}

错误码

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

变更历史

更多信息，参考变更详情。