すべてのプロダクト
Search

このプロダクト

    Data Management:ListWorkspaces

    ドキュメントセンター

    Data Management:ListWorkspaces

    最終更新日:Mar 21, 2026

    テナントのワークスペース一覧を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:ListWorkspaces

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AlreadyJoined

    boolean

    任意

    現在のユーザーが当該ワークスペースに参加済みかどうかを指定します。

    true
    SearchKey

    string

    任意

    検索キーワードです。あいまい検索がサポートされています。

    poc_test
    Region

    string

    任意

    バケットが配置されているリージョンです。

    cn-hangzhou
    ServiceAccountId

    integer

    任意

    サービスアカウント ID です。

    12345
    WorkspaceId

    integer

    任意

    ワークスペース ID です。

    12****
    PageNumber

    integer

    任意

    ページ番号です。

    1
    PageSize

    integer

    任意

    1 ページあたりの表示件数です。

    10
    VpcId

    string

    任意

    仮想プライベートクラウド (VPC) の ID です。

    説明

    このパラメーターはフィルターとして使用できません。

    vpc-bp10wnlcmor****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

    EE214ECD-4330-503A-82F0-FFB03975****
    ErrorCode

    string

    エラーコードです。

    UserNotExist
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージです。

    UnknownError
    Success

    boolean

    呼び出しが成功したかどうかを示します。有効な値は以下のとおりです。

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    TotalCount

    integer

    条件に合致するワークスペースの総数です。

    10
    Data

    object

    BaseWorkspaces

    array<object>

    データセットです。

    object

    Description

    string

    ワークスペースの説明文です。

    Test
    CreatorId

    integer

    作成者の ID です。

    123
    OwnerUid

    string

    所有者の Alibaba Cloud UID です。

    15608564799****
    WorkspaceId

    integer

    ワークスペース ID です。

    8652340494****
    GmtModified

    string

    更新日時です。

    2025-01-01 00:00:00
    ServiceAccountId

    integer

    サービスアカウントの ID です。

    12345
    CreatorUid

    string

    作成者の Alibaba Cloud アカウント UID です。

    1344****
    ServiceAccountNickName

    string

    サービスアカウントのニックネームです。

    testname
    Name

    string

    ワークスペースの名前です。

    workspace-xxxx
    AlreadyJoined

    boolean

    現在のユーザーが当該ワークスペースに参加済みかどうかを示します。

    true
    TenantId

    integer

    当該ワークスペースが所属するテナントの ID です。

    23456
    GmtCreate

    string

    作成日時です。

    2025-01-01 00:00:00
    ServiceAccountUid

    string

    サービスアカウントの Alibaba Cloud アカウント UID です。

    1422****
    OwnerId

    integer

    所有者 ID です。

    123****
    VpcId

    string

    VPC ID です。

    vpc-25fl3qjqb****
    Region

    string

    リージョン ID です。

    cn-hangzhou
    WorkspaceName

    string

    ワークスペースの名前です。

    test-workspace
    CreatorNickName

    string

    作成者のニックネームです。

    work*****
    OwnerNickName

    string

    所有者のニックネームです。

    hel****
    NextToken

    string

    NextToken は機能しません。

    token-xxx
    MaxResults

    integer

    条件に合致するワークスペースの総数であり、TotalCount パラメーターと同一の値です。

    10

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "EE214ECD-4330-503A-82F0-FFB03975****",
  "ErrorCode": "UserNotExist",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 10,
  "Data": {
    "BaseWorkspaces": [
      {
        "Description": "Test",
        "CreatorId": 123,
        "OwnerUid": "15608564799****",
        "WorkspaceId": 0,
        "GmtModified": "2025-01-01 00:00:00",
        "ServiceAccountId": 12345,
        "CreatorUid": "1344****",
        "ServiceAccountNickName": "testname",
        "Name": "workspace-xxxx",
        "AlreadyJoined": true,
        "TenantId": 23456,
        "GmtCreate": "2025-01-01 00:00:00",
        "ServiceAccountUid": "1422****",
        "OwnerId": 0,
        "VpcId": "vpc-25fl3qjqb****",
        "Region": "cn-hangzhou",
        "WorkspaceName": "test-workspace",
        "CreatorNickName": "work*****",
        "OwnerNickName": "hel****"
      }
    ]
  },
  "NextToken": "token-xxx",
  "MaxResults": 10
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。