GetWorkspace API 概要 - Data Management (DMS)

ワークスペースの詳細情報を照会します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
WorkspaceId	integer	必須	DMS ワークスペースの ID。	12****

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエスト ID。この ID を使用してログを特定し、問題のトラブルシューティングを行います。	FE8EE2F1-4880-46BC-A704-5CF63EAF****
Message	string	リクエストが失敗した場合に返されるエラーメッセージ。	UnknownError
Data	object	返されたデータ。
WorkspaceId	integer	ワークスペース ID。	863020290155****
WorkspaceName	string	ワークスペースの名前。	workspace_xxx
Description	string	ワークスペースの説明。	Test
RegionId	string	ワークスペースが属するリージョンの ID。	cn-hangzhou
OwnerId	string	オーナー ID。	12345****
ServiceAccountId	string	サービスアカウントの ID。	12345****
Tid	integer	テナント ID。説明テナント ID を確認するには、Data Management (DMS) コンソールにアクセスし、右上隅のプロフィール画像にマウスポインターを合わせます。詳細については、「DMS テナントの管理」トピック内の「現在のテナントに関する情報の表示」をご参照ください。	3322****
VpcId	string	VPC ID。	vpc-xxxx
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF****",
  "Message": "UnknownError",
  "Data": {
    "WorkspaceId": 0,
    "WorkspaceName": "workspace_xxx",
    "Description": "Test",
    "RegionId": "cn-hangzhou",
    "OwnerId": "12345****",
    "ServiceAccountId": "12345****",
    "Tid": 0,
    "VpcId": "vpc-xxxx"
  },
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	WorkspaceNotExist	The specified workspace not exist.

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

変更履歴

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