edit-icon download-icon

API for user management

最終更新日: Dec 13, 2018

ユーザーを追加する

このAPIは、ユーザーを追加するために使用されます。

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:AddUsers。
RegionId String はい - リージョンID。
ClusterId String はい - クラスタID。
User.n.Name String はい - 追加するn番目のアカウントのユーザー名(nは1から始まります。nを複数回入力できます)。6〜30文字で、大文字/小文字のアルファベット、数字、および 「.」の文字列です。先頭はアルファベットでなければなりません。
User.n.Group String はい - 追加するn番目のアカウントのユーザーグループ(nは1から始まります。nは複数回入力できます)。現在、ユーザーグループ「users」と「wheel」のみサポートされています。「wheel」はsudo権限を持つユーザーグループです。
User.n.Password String はい - 追加するn番目のアカウントのパスワード(nは1から始まります。nは複数回入力できます)。パスワードは8〜30文字の文字列で、大文字/小文字のアルファベット、数字、特殊文字を含む必要があります。パスワード漏洩を防ぐためにHTTPSでAPIを呼び出します。

リターンパラメータ

パブリックリターンパラメータ。

エラーコード

コード 説明
InvalidParams 無効なパラメータ
UsernameExist ユーザー名は既に存在します。
UnknownError 不明なエラー

DeleteUsers

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:DeleteUsers
RegionId String はい - リージョンID
ClusterId String はい - クラスタID
User.n.Name String はい - 削除するn番目のアカウントのユーザー名(nは1から始まります)。複数のエントリがサポートされています。

:ホームディレクトリ内のファイルは削除できません。

リターンパラメータ

パブリックリターンパラメータ。

エラーコード

コード 説明
InvalidParams パラメータが無効です。
UsernameNotExist ユーザー名が存在しません。
UnknownError 不明なエラー。

ListUsers

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:ListUsers
RegionId String はい - リージョンID
ClusterId String はい - クラスタID
PageNumber Integer いいえ 1 表示されたページ番号。初期値:1
PageSize Integer いいえ 10 ページあたりのエントリ数。値の範囲:1〜50

リターンパラメータ

パブリックリターンパラメータと次のパラメータ

フィールド タイプ 説明
User Array ユーザーアカウントの配列
TotalCount Integer リスト内のエントリの合計数
PageNumber Integer 現在のページ番号
PageSize Integer 現在のページのエントリ数

UserInfo構造体の各要素には、次のフィールドがあります。

フィールド タイプ 説明
User String ユーザー名。
Group String ユーザー権限グループ。現在、ユーザーグループの「users」と「wheel」がサポートされています。ユーザグループ「users」のユーザは一般的な権限を持ち、ユーザグループ「wheel」のユーザはsudo権限を持っています。
AddTime String ユーザー追加時間。

エラーコード

コード 説明
InvalidParams 無効なパラメータ
UnknownError 不明なエラー

ModifyUserGroups

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース、必須。値:ModifyUserGroups。
RegionId String はい - リージョンID。
ClusterId String はい - クラスタID。
User.n.Name String はい - ユーザーグループが変更されるn番目のアカウントのユーザー名。 (nは1から始まります。複数のエントリがサポートされています)。
User.n.Group String はい - 変更するn番目のアカウントのユーザーグループ(nは1から始まります。nを複数回入力できます)。現在、ユーザーグループ「users」と「wheel」のみサポートされています。「wheel」はsudo権限を持つユーザーグループです。

リターンパラメータ

パブリックリターンパラメータ。

エラーコード

コード 説明
InvalidParams パラメータが無効です。
UsernameNotExist ユーザー名が存在しません。
UnknownError 不明なエラー。

ユーザーパスワードの変更

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:ModifyUserPasswords。
RegionId String はい - リージョンID。
ClusterId String はい - クラスタID。
User.n.Name String はい - 変更するn番目のアカウントのユーザー名。 (nは1から始まります。複数の拡張子がサポートされています)。
User.n.Password String はい - n番目のアカウントの新しいパスワード(nは1から始まります。nは複数回入力できます)。パスワードは8〜30文字の文字列で、大文字/小文字のアルファベット、数字、特殊文字を含む必要があります。パスワード漏洩を防ぐためにHTTPSでAPIを呼び出します。

リターンパラメータ

パブリックリターンパラメータ。

エラーコード

コード 説明
InvalidParams パラメータが無効です。
UsernameNotExist ユーザー名が存在しません。
UnknownError 不明なエラー。