文档

DescribeSpaces - 查询空间列表信息

根据 spaceId、租户ID、EMAS项目空间或者套餐规格来查询空间实例信息。

接口说明

说明 仅商业版支持该功能

调试

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

授权信息

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

请求参数

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

页码,从 0 开始。

0
PageSizeinteger

页大小,默认值为 10。

10
SpaceIdsarray

服务空间 ID 列表。

string

服务空间 ID。

mp-c2d29d85-44f5-4ede-****-4f803ba06a7c
TenantIdstring

租户 ID。

XKHKTPDJ
EmasWorkspaceIdlong

EMAS 项目空间 ID。

3449110
SpecCodestring

套餐规格

ULTIMATE

返回参数

名称类型描述示例值
object
RequestIdstring

唯一请求 ID。

68B76E59-CC10-5EEC-BCED-73A6C51179BC
GmtCreatestring

时间。

2024-03-27T06:43:17Z
Countinteger

服务空间总数。

10
Spacesobject []

服务空间。

SpaceIdstring

服务空间 ID。

mp-f215973f-db40-4013-92a8-b09690c7****
InstanceIdstring

实例 ID。

emas_EmasServerlessPre_public_cn-0ju2pax****
EmasWorkspaceIdlong

EMAS 项目空间 ID。

3818905
Namestring

服务空间名称。

myspace
Descriptionstring

服务空间描述。

线上
ServiceStatusstring

空间状态。返回值为 UNINITIALIZED、PRODUCING、PRODUCE_FAILED、PAUSED、IN_SERVICE

IN_SERVICE
PackageStatusstring
  • RENEWING 续费中
  • UPGRADING 升配中
UPGRADING
GmtCreatestring

创建时间。

2022-05-19T06:06:05Z
GmtModifiedstring

修改时间。

2022-05-19T06:06:05Z
SpecCodestring
  • FREE 开发者版
  • BASE 基础版
  • STANDARD 标准版
  • PROFESSIONAL 专业版
  • ENTERPRISE 企业版
  • UTIMATE 旗舰版
ENTERPRISE
ChargeTypestring
  • PREPAY 套餐付费
  • POSTPAY 按量计费
PREPAY
OrderTypestring
  • BUY 新购
  • RENEW 续费
  • UPGRADE 升配
BUY
AutoRenewboolean

付费类型为包年包月时,取值如下:

  • true:自动续费。
  • false:手动续费。
true
RenewDurationstring

续费时长。

3
PackageStartDatestring

资源包起始时间。

2022-06-18T16:00:00Z
PackageEndDatestring

资源包到期时间。

2022-09-18T16:00:00Z

示例

正常返回示例

JSON格式

{
  "RequestId": "68B76E59-CC10-5EEC-BCED-73A6C51179BC",
  "GmtCreate": "2024-03-27T06:43:17Z",
  "Count": 10,
  "Spaces": [
    {
      "SpaceId": "mp-f215973f-db40-4013-92a8-b09690c7****",
      "InstanceId": "emas_EmasServerlessPre_public_cn-0ju2pax****",
      "EmasWorkspaceId": 3818905,
      "Name": "myspace",
      "Description": "线上",
      "ServiceStatus": "IN_SERVICE",
      "PackageStatus": "UPGRADING",
      "GmtCreate": "2022-05-19T06:06:05Z",
      "GmtModified": "2022-05-19T06:06:05Z",
      "SpecCode": "ENTERPRISE",
      "ChargeType": "PREPAY",
      "OrderType": "BUY",
      "AutoRenew": true,
      "RenewDuration": "3",
      "PackageStartDate": "2022-06-18T16:00:00Z",
      "PackageEndDate": "2022-09-18T16:00:00Z"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈