DisableUser API によるユーザー無効化 - Data Management (DMS)

操作説明

この操作を呼び出してユーザーを無効にする効果は、DMS Enterprise コンソールで [システム管理] > [ユーザー管理] を選択してユーザーを無効にする場合と同じです。DMS Enterprise の管理者はこの操作を呼び出して、DMS Enterprise で一時的に使用されなくなったユーザーを無効にできます。ユーザーが無効になると、対応する Alibaba Cloud アカウントまたは Resource Access Management (RAM) ユーザーのデータソース権限、データ所有者構成、およびデータベース管理者 (DBA) 構成が取り消され、無効になります。

説明

この操作は、Alibaba Cloud アカウントまたは RAM ユーザーが企業の DMS Enterprise にログインするのを停止するだけで、Alibaba Cloud アカウントまたは RAM ユーザー自体を無効にするものではありません。ユーザーが無効化された後、そのユーザーが再度有効化されない限り、Alibaba Cloud アカウントまたは RAM ユーザーは DMS Enterprise にログインできなくなります。ただし、無効化されたユーザーは DMS Enterprise 内に引き続き存在します。

今すぐお試しください

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

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナントの ID。`GetUserActiveTenant` または `ListUserTenants` 操作を呼び出して、テナント ID を取得できます。	-1
Uid	string	必須	Alibaba Cloud アカウントの UID。	12345

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。	403
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージ。	The specified user not exists.
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "ErrorCode": "403",
  "ErrorMessage": "The specified user not exists.",
  "Success": true
}

エラーコード

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

変更履歴

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