ListUsers API を使用したクラスター内ユーザークエリ - E-HPC - Alibaba Cloud - Elastic High Performance Computing

クラスター内のユーザーリストを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ehpc:ListUsers

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスターの ID。 ListClusters を呼び出してクラスターの ID を取得できます。	ehpc-hz-FYUr32****
PageNumber	integer	任意	ページ番号。最小値: 1 デフォルト値: 1	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: 1～50。デフォルト値: 10	10

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	1 ページあたりのエントリ数。	1
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE7****
PageNumber	integer	現在のページ番号。	1
TotalCount	integer	リスト内のエントリの総数。	1
Users	object
UserInfo	array<object>	ユーザーリスト情報。
	object
Name	string	ユーザー名。	user1
AddTime	string	ユーザーが追加された時間。時間は YYYY-MM-DDTHH:mm:ss フォーマットで、タイムゾーン情報は含まれません。	2018-07-18T17:46:47
Group	string	ユーザーグループ。有効な値: users: 通常の権限グループ。ジョブのコミットとデバッグのみが必要な通常のユーザーに適しています。 wheel: sudo 権限グループ。クラスター管理が必要な管理者に適しています。管理者は、ジョブのコミットとデバッグに加えて、ソフトウェアのインストール、ノードの再起動、その他の操作を実行する sudo コマンドを実行できます。	wheel

例

成功レスポンス

JSONJSON

{
  "PageSize": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageNumber": 1,
  "TotalCount": 1,
  "Users": {
    "UserInfo": [
      {
        "Name": "user1",
        "AddTime": "2018-07-18T17:46:47",
        "Group": "wheel"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The specified parameter %s is invalid.	指定されたパラメーター %s が無効です。
500	UnknownError	An unknown error occurred.	不明なエラーが発生しました。
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	クラスターのステータスではこの操作を実行できません。
404	ManagerNotFound	The manager nodes do not exist or their status is abnormal.	管理ノードが存在しないか、異常な状態にあります。
404	ClusterNotFound	The specified cluster does not exist.	指定されたクラスターが存在しません。パラメーターが正しいかどうかを確認してください。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	サービスが一時的に利用できないため、リクエストが失敗しました。
406	AgentError	The agent service request failed.	操作が成功しませんでした: %s。
406	AgentError.Account.DomainNotExist	The specified domain does not exist: %s.	ドメインサービスが存在しません: {}。このパラメーターが正しいかどうかを確認してください。
406	AgentError.Account.GetentPasswdFailure	Failed to get the user list: %s.	ドメインユーザーリストの取得に失敗しました: {}
406	AgentError.Account.GetUserListFailure	Get user list fail: %s	ユーザーリストの取得に失敗しました: %s。
407	NotAuthorized	You are not authorized by RAM for this request.	このリクエストには RAM 認可が付与されていません。

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

変更履歴

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