ListSaasService - SaaS服务列表

更新时间:
复制 MD 格式

查询SaaS服务列表

接口说明

使用说明

本接口用于查看所有 SaaS 服务信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:ListSaasService

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

否

工作空间所在的地域 ID。

cn-hangzhou

WorkspaceId

string

是

工作空间 ID。

ws-*****

ServiceType

string

是

Service type, with the following value:

  • memroy

  • drama

drama

MaxResults

integer

否

本次读取的最大数据量,默认值为 10。

50

NextToken

string

否

分页查询时,下一个查询开始 Token。

caeba0bbb2be03f84eb48b699f0a4883

返回参数

名称

类型

描述

示例值

object

TotalRecordCount

integer

总记录数。

2

RequestId

string

请求 ID。

34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad

Items

array<object>

实例详情列表。

array<object>

实例详情列表。

ServiceId

string

服务 ID。

agdb-xxxx

ServiceName

string

服务名称。

agdb-xxxx

ServiceType

string

服务类型:

  • memory

  • drama

memory

Status

string

服务状态:

  • active: 运行中

  • creating: 创建中

active

CreateTime

string

创建时间。

2021-10-09T04:54:08Z

Cu

integer

计算资源。

1

PayType

string

计费类型,取值说明:

  • POSTPAY:按量付费。

  • PREPAY:包年包月。

POSTPAY

ExpireTime

string

到期时间。

2021-10-15T16:00:00Z

Plan

string

【已废弃】

deprecated

DeletionProtection

boolean

是否已开启释放保护功能。返回值:

  • true:已开启

  • false:未开启

True

Components

array<object>

服务子组件列表。

object

数据集加速组件的唯一标识符。

ComponentId

string

组件 ID。

0644c5aa-5306-478b-ac39-bb4660cdc9f7

ComponentType

string

子组件的类型。

gamestudio

Cu

string

组件计算资源。

2

Status

string

服务状态:

  • active: 运行中

  • creating: 创建中

active

CreateTime

string

创建时间。

2021-10-09T04:54:08Z

DeletionProtection

boolean

释放保护。

true

NextToken

string

下一个查询开始 Token。

caeba0bbb2be03f84eb48b699f0a4883

MaxResults

integer

本次读取的最大数据量,默认值为 10。

50

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 2,
  "RequestId": "34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad",
  "Items": [
    {
      "ServiceId": "agdb-xxxx",
      "ServiceName": "agdb-xxxx",
      "ServiceType": "memory",
      "Status": "active",
      "CreateTime": "2021-10-09T04:54:08Z",
      "Cu": 1,
      "PayType": "POSTPAY",
      "ExpireTime": "2021-10-15T16:00:00Z",
      "Plan": "deprecated",
      "DeletionProtection": true,
      "Components": [
        {
          "ComponentId": "0644c5aa-5306-478b-ac39-bb4660cdc9f7",
          "ComponentType": "gamestudio",
          "Cu": "2",
          "Status": "active",
          "CreateTime": "2021-10-09T04:54:08Z",
          "DeletionProtection": true
        }
      ]
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "MaxResults": 50
}

错误码

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

变更历史

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