GetAuthorityTemplate による権限テンプレート情報のクエリ - DMS

権限テンプレートの情報を照会します。

操作説明

Data Management (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:GetAuthorityTemplate

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TemplateId	integer	必須	権限テンプレートの ID です。	1563
Tid	integer	任意	テナントの ID です。テナント ID を照会するには、GetUserActiveTenant または ListUserTenants 操作を呼び出します。	3***

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	リクエストが失敗した場合に返されるエラーコードです。	UnknownError
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージです。	UnknownError
AuthorityTemplateView	object	権限テンプレートの詳細です。
TemplateId	integer	権限テンプレートの ID です。	1563
CreatorId	integer	権限テンプレートを作成したユーザーの ID です。	12***
Name	string	権限テンプレートの名前です。	测试模板。
Description	string	権限テンプレートの説明です。	此模板用于业务测试。
CreateTime	string	権限テンプレートの作成時刻です。形式は yyyy-MM-DD HH:mm:ss です。	2023-01-01 00:00:00
AuthorityTemplateItemList	object
AuthorityTemplateItem	array<object>	権限テンプレート内のリソース情報です。
	object
ItemId	integer	リソースの ID です。	12***
TemplateId	integer	権限テンプレートの ID です。	1563
ModifierId	integer	リソースを変更したユーザーの ID です。	51***
ResourceType	string	リソースの種類です。有効な値は以下のとおりです。 INSTANCE: インスタンス LOGIC_DB: 論理データベース META_DB: 物理データベース LOGIC_TABLE: 論理テーブル SINGLE_TABLE: 物理テーブル	INSTANCE
InstanceId	integer	インスタンスの ID です。	188****
DbId	integer	データベースの ID です。	43***
TableName	string	テーブルの名前です。	ExampleTable
Attribute	string	その他の情報です。たとえば、インスタンスへのログイン権限を権限テンプレートに追加できます。	"permissionTypes": [ "LOGIN" ]
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true: リクエストは成功しました。 false: リクエストは失敗しました。	true
Tid	integer	テナントの ID です。	3***

例

成功レスポンス

JSONJSON

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "AuthorityTemplateView": {
    "TemplateId": 1563,
    "CreatorId": 0,
    "Name": "测试模板。",
    "Description": "此模板用于业务测试。",
    "CreateTime": "2023-01-01 00:00:00",
    "AuthorityTemplateItemList": {
      "AuthorityTemplateItem": [
        {
          "ItemId": 0,
          "TemplateId": 1563,
          "ModifierId": 0,
          "ResourceType": "INSTANCE",
          "InstanceId": 0,
          "DbId": 0,
          "TableName": "ExampleTable",
          "Attribute": "\"permissionTypes\": [\n            \"LOGIN\"\n          ]"
        }
      ]
    }
  },
  "Success": true,
  "Tid": 0
}

エラーコード

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

変更履歴

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