すべてのプロダクト
Search

このプロダクト

    Data Management:GetLhSpaceByName

    ドキュメントセンター

    Data Management:GetLhSpaceByName

    最終更新日:Mar 21, 2026

    Data Management (DMS) におけるワークスペース名を指定して、対応するワークスペースの情報を照会します。

    操作説明

    DMS 管理者またはデータベース管理者 (DBA) である必要があります。

    今すぐお試しください

    この 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:GetLhSpaceByName

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SpaceName

    string

    必須

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

    test_space
    Tid

    integer

    任意

    テナント ID です。テナント ID を取得するには、GetUserActiveTenant または ListUserTenants 操作を呼び出します。

    3000

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの ID です。

    FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコードです。

    UnknownError
    ErrorMessage

    string

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

    UnknownError
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値は以下のとおりです。

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

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

    true
    LakehouseSpace

    object

    データウェアハウス開発用のワークスペースです。

    Id

    integer

    ワークスペースの ID です。

    1
    SpaceName

    string

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

    test_space
    CreatorId

    string

    ワークスペースを作成したユーザーの ID です。

    51***
    TenantId

    string

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

    3***
    Description

    string

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

    test
    Mode

    integer

    ワークスペースの実行モードです。有効な値は以下のとおりです。

    • 0: 基本モード

    • 1: 標準モード

    1
    DwDbType

    string

    データベースの種別です。有効な値は以下のとおりです。

    • 14: AnalyticDB for MySQL

    • 18: AnalyticDB for PostgreSQL

    14
    SpaceConfig

    string

    ワークスペースの構成です。有効な値は以下のとおりです。

    • skipManualRunCheck: 試験実行フェーズでセキュリティルールのチェックをスキップします。

    • skipPublishApprove: 公開および運用・保守 (O&M) の承認をスキップします。

    {\"skipManualRunCheck\":true,\"skipPublishApprove\":true}
    DevDbId

    integer

    開発データベースの ID です。

    2435****
    ProdDbId

    integer

    本番データベースの ID です。

    2442****
    IsDeleted

    boolean

    ワークスペースが削除済みかどうかを示します。有効な値は以下のとおりです。

    • true: ワークスペースは削除済みです。

    • false: ワークスペースは削除されていません。

    false

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "FE8CA4A8-AB2D-55B7-BD30-01A4609F40D8",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "LakehouseSpace": {
    "Id": 1,
    "SpaceName": "test_space",
    "CreatorId": "51***",
    "TenantId": "3***",
    "Description": "test",
    "Mode": 1,
    "DwDbType": "14",
    "SpaceConfig": "{\\\"skipManualRunCheck\\\":true,\\\"skipPublishApprove\\\":true}",
    "DevDbId": 0,
    "ProdDbId": 0,
    "IsDeleted": false
  }
}

    エラーコード

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

    変更履歴

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