E-HPC クラスターユーザーの ListUsers API リファレンス - E-HPC

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

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスター ID。	ehpc-hz-FYUr32****
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりの表示件数。有効な値：1～50。デフォルト値：10。	10

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	1 ページあたりの表示件数。	10
RequestId	string	リクエスト ID。	04F0F334-1335-436C-A1D7-6C044FE7****
PageNumber	integer	ページ番号。	1
TotalCount	integer	返された合計件数。	15
Users	object
UserInfo	array<object>	ユーザー情報。
	object	ユーザーに関する情報。
UserName	string	ユーザー名。	testuser
AddTime	string	ユーザーが初めて追加された時刻。	2014-08-22T17:46:47
Group	string	権限グループの名前。有効な値： users：一般ユーザ向けの通常権限。ジョブの送信およびデバッグのみが必要な場合に適しています。 wheel：管理者向けの sudo 権限。クラスターの管理が必要な場合に適しています。ジョブの送信およびデバッグに加え、sudo コマンドを実行してソフトウェアのインストールやノードの再起動も可能です。	users
UserId	string	ユーザー ID。	1001
GroupId	string	権限グループ ID。	100

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageNumber": 1,
  "TotalCount": 15,
  "Users": {
    "UserInfo": [
      {
        "UserName": "testuser",
        "AddTime": "2014-08-22T17:46:47",
        "Group": "users",
        "UserId": "1001",
        "GroupId": "100"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParams	The specified parameter %s is invalid.
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.
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
407	NotAuthorized	You are not authorized by RAM for this request.

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

変更履歴

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