ListAuthorizedInstancesForUser API 概要 - 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:ListAuthorizedInstancesForUser

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserId	string	必須	ユーザー ID。ユーザー ID を照会するには、GetUser 操作を呼び出します。説明 IdentityType が USER に設定されている場合、このパラメーターは必須です。	51****
EnvType	string	任意	データベースインスタンスがデプロイされる環境の種類。有効な値は以下のとおりです。 product：本番環境 dev：開発環境 pre：プレリリース環境 test：テスト環境 sit：システム統合テスト (SIT) 環境 uat：ユーザ受入テスト (UAT) 環境 pet：ストレステスト環境 stag：ステージング環境	product
DbType	string	任意	データベースの種類。有効な値は以下のとおりです。 MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	MySQL
SearchKey	string	任意	検索キーワード。	policy_test
PageNumber	string	任意	ページ番号。	1
PageSize	string	任意	1 ページあたりに返すエントリ数。	20
Tid	integer	任意	テナント ID。説明テナント ID を表示するには、DMS コンソールを開き、右上隅のプロフィール画像にカーソルを合わせます。「DMS テナントの管理」トピックの「現在のテナントに関する情報を表示する」セクションをご参照ください。	3***

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ
RequestId	string	リクエスト ID。この ID を使用してログを照会したり、問題のトラブルシューティングを行ったりできます。	B7DB89CC-017D-5503-8953-38FFE241A618
Instances	array<object>	ユーザーが権限を持つインスタンスのリスト。
	array<object>	ユーザーが権限を持つインスタンス。
InstanceId	string	インスタンス ID。	21****
Host	string	インスタンスへの接続に使用されるエンドポイント。	rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com
Port	string	インスタンスへの接続に使用されるポート番号。	3306
DbType	string	インスタンスで実行されるデータベースエンジン。	MySQL
UserId	string	ユーザー ID。	51****
UserName	string	ユーザー名。	user_test
InstanceAlias	string	インスタンスのエイリアス。	DMS_TEST
EnvType	string	データベースインスタンスが属する環境の種類。	product
PermissionDetail	object	権限の詳細。権限のソースによって、権限詳細の形式は異なります。たとえば、通常の権限がソースの場合、以下のパラメーターが返されます。
DsType	string	操作対象となるオブジェクトの種類。	DATABASE
PermType	string	権限の種類。有効な値は以下のとおりです。 QUERY：クエリ権限 EXPORT：データエクスポート権限 CORRECT：データ変更権限	CORRECT
ExpireDate	string	権限の有効期限。	2024-12-06 10:00:00
Message	string	権限のソースが権限ポリシーである場合、このパラメーターの値にはポリシー名およびユーザーに許可された操作が含まれます。	权限策略通过，策略名：INSTANCE_OWNER，被允许的操作：instance:InstanceQuery

例

成功レスポンス

JSONJSON

{
  "RequestId": "B7DB89CC-017D-5503-8953-38FFE241A618",
  "Instances": [
    {
      "InstanceId": "21****",
      "Host": "rm-2zex9lrc0gz0****.mysql.rds.aliyuncs.com",
      "Port": "3306",
      "DbType": "MySQL",
      "UserId": "51****",
      "UserName": "user_test",
      "InstanceAlias": "DMS_TEST",
      "EnvType": "product",
      "PermissionDetail": {
        "DsType": "DATABASE",
        "PermType": "CORRECT",
        "ExpireDate": "2024-12-06 10:00:00\n",
        "Message": "权限策略通过，策略名：INSTANCE_OWNER，被允许的操作：instance:InstanceQuery"
      }
    }
  ]
}

エラーコード

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

変更履歴

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