操作説明

説明

1 人以上のバスティオンホストユーザーをロックし、O&M オペレーションの実行を禁止します。特定の期間内にバスティオンホストを使用する必要がないユーザーがいる場合、そのユーザーアカウントをロックします。ロックされたユーザーは、権限を持つホストにログインしたり、O&M オペレーションを実行したりすることはできません。後でユーザーのロックを解除するには、UnlockUsers API を呼び出します。

制限

この API は、1 アカウントあたり毎秒 10 回まで呼び出すことができます。1 秒あたりの呼び出し数が制限を超えると、スロットリングがトリガーされます。その結果、お客様のビジネスに影響が生じる可能性があります。この API を呼び出す際は、制限に注意することを推奨します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-bastionhost:LockUsers

update

*インスタンス

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	ロック対象のユーザーが属するバスティオンホストの ID です。説明 DescribeInstances API を呼び出して、バスティオンホストの ID を照会できます。	bastionhost-cn-st220aw****
RegionId	string	任意	ロック対象のユーザーが属するバスティオンホストのリージョン ID です。説明リージョン ID とリージョン名のマッピングの詳細については、「リージョンとゾーン」をご参照ください。	cn-hangzhou
UserIds	string	必須	ロック対象のユーザーの ID です。値は JSON 文字列です。最大 100 個のユーザー ID を指定できます。複数の ID を指定する場合は、コンマ (,) で区切ります。説明 ListUsers API を呼び出して、ユーザーの ID を照会できます。	["1","2","3"]

すべての Alibaba Cloud API リクエストには、共通リクエストパラメーターを含める必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。リクエスト例の詳細については、このトピックの「例」セクションをご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。問題の特定やトラブルシューティングに使用されます。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	呼び出しの結果です。
	object
Code	string	呼び出しが成功したかどうかを示すリターンコードです。有効な値は次のとおりです。 OK：呼び出しは成功しました。 UNEXPECTED：不明なエラーが発生しました。 INVALID_ARGUMENT：リクエストパラメーターが無効です。説明リクエストパラメーターが有効であることを確認し、API を再度呼び出してください。 OBJECT_NOT_FOUND：操作対象の指定されたオブジェクトが存在しません。説明指定されたバスティオンホストの ID が存在するか、指定されたユーザー ID が有効かを確認してから、API を再度呼び出してください。 OBJECT_ALREADY_EXISTS：指定されたオブジェクトはすでに存在します。	OK
Message	string	このパラメーターは非推奨です。	None
UserId	string	ユーザーの ID です。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "None",
      "UserId": "1"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	引数が無効です。	引数が無効です。
500	InternalError	不明なエラーが発生しました。	不明なエラーが発生しました。

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

変更履歴

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