Bastionhost:CreateUser - Bastionhost

踏み台ホストにユーザーを追加します。

操作説明

CreateUser 操作を呼び出して、ローカルユーザー、Resource Access Management (RAM) ユーザー、Active Directory (AD) 認証ユーザー、または Lightweight Directory Access Protocol (LDAP) 認証ユーザーを踏み台ホストに追加できます。Bastionhost の管理者がユーザーを踏み台ホストに追加すると、運用保守 (O&M) エンジニアはそのユーザーとして踏み台ホストにログインし、管理権限が付与されているホストで O&M 操作を実行できます。

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

今すぐお試しください

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

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	ユーザーを追加する踏み台ホストの ID。説明 DescribeInstances 操作を呼び出して、踏み台ホストの ID をクエリできます。	bastionhost-cn-st220aw****
RegionId	string	任意	ユーザーを追加する踏み台ホストのリージョン ID。説明リージョン ID とリージョン名のマッピングの詳細については、「リージョンとゾーン」をご参照ください。	cn-hangzhou
Source	string	必須	追加するユーザーのタイプ。有効な値： Local：ローカルユーザー。 Ram：RAM ユーザー。 AD：AD 認証ユーザー。 LDAP：LDAP 認証ユーザー。	Local
UserName	string	必須	追加するユーザーのログイン名。ログイン名は 1～128 文字で、文字、数字、アンダースコア (_) のみ使用できます。	abc_def
Password	string	任意	追加するユーザーのログインパスワード。ログインパスワードは 8～128 文字で、大文字、小文字、数字、特殊文字を含める必要があります。説明このパラメーターは、Source が Local に設定されている場合に必須です。	213****
DisplayName	string	任意	追加するユーザーの表示名。表示名は最大 128 文字です。説明このパラメーターを空のままにすると、ログイン名が表示名として使用されます。	Bob
Comment	string	任意	追加するユーザーの備考。備考は最大 500 文字です。	comment
Email	string	任意	追加するユーザーの E メールアドレス。説明 TwoFactorStatus が Enable に設定され、TwoFactorMethods が email に設定されている場合、または TwoFactorStatus が Global に設定され、グローバル二要素認証設定で TwoFactorMethods が email に設定されている場合、このパラメーターは必須です。 GetInstanceTwoFactor 操作を呼び出して、グローバル二要素認証設定をクエリできます。	username@example.com
Mobile	string	任意	追加するユーザーの携帯電話番号。説明 TwoFactorStatus が Enable に設定され、TwoFactorMethods が sms または dingtalk に設定されている場合、または TwoFactorStatus が Global に設定され、グローバル二要素認証設定で TwoFactorMethods が sms または dingtalk に設定されている場合、このパラメーターは必須です。 GetInstanceTwoFactor 操作を呼び出して、グローバル二要素認証設定をクエリできます。	1359999****
SourceUserId	string	任意	追加するユーザーの一意の ID。説明このパラメーターは、踏み台ホストの RAM ユーザーを一意に識別します。Source が Ram に設定されている場合、このパラメーターは必須です。RAM の ListUsers 操作を呼び出して、UserId レスポンスパラメーターからユーザーの一意の ID を取得できます。 Source が AD または LDAP に設定されている場合、このパラメーターは必須です。追加する Active Directory (AD) 認証ユーザーまたは Lightweight Directory Access Protocol (LDAP) 認証ユーザーの識別名 (DN) を指定します。	122748924538****
MobileCountryCode	string	任意	ユーザーの携帯電話番号が登録されている場所。デフォルト値：CN。有効な値： CN：中国本土。国際電話番号は +86 です。 HK：中国 (香港)。国際電話番号は +852 です。 MO：中国 (マカオ)。国際電話番号は +853 です。 TW：中国 (台湾)。国際電話番号は +886 です。 RU：ロシア。国際電話番号は +7 です。 SG：シンガポール。国際電話番号は +65 です。 MY：マレーシア。国際電話番号は +60 です。 ID：インドネシア。国際電話番号は +62 です。 DE：ドイツ。国際電話番号は +49 です。 AU：オーストラリア。国際電話番号は +61 です。 US：米国。国際電話番号は +1 です。 AE：UAE。国際電話番号は +971 です。 JP：日本。国際電話番号は +81 です。 GB：イギリス。国際電話番号は +44 です。 IN：インド。国際電話番号は +91 です。 KR：韓国。国際電話番号は +82 です。 PH：フィリピン。国際電話番号は +63 です。 CH：スイス。国際電話番号は +41 です。 SE: スウェーデン。国際電話番号は +46 です。 SA: サウジアラビア。国際電話番号は +966 です。	CN
EffectiveStartTime	integer	任意	ユーザーの有効期間の開始時刻。UNIX タイムスタンプを指定します。単位：秒。	1669630029
EffectiveEndTime	integer	任意	ユーザーの有効期間の終了時刻。UNIX タイムスタンプを指定します。単位：秒。	1672502400
NeedResetPassword	boolean	任意	次回のログイン時にパスワードのリセットが必要かどうかを指定します。有効な値： true false 説明このパラメーターを空のままにすると、デフォルト値の false が使用されます。	true
TwoFactorStatus	string	任意	ユーザーに対して二要素認証が有効になっているかどうかを指定します。有効な値： Global：グローバル設定が適用されます。 Disable：二要素認証は無効です。 Enable：二要素認証は有効で、ユーザー固有の設定が適用されます。説明このパラメーターを空のままにすると、デフォルト値の Global が使用されます。	Enable
TwoFactorMethods	string	任意	二要素認証メソッド。メソッドは 1 つだけ選択できます。有効な値： sms：ショートメッセージベースの二要素認証。 email：E メールベースの二要素認証。 dingtalk：DingTalk ベースの二要素認証。 totp OTP：ワンタイムパスワード (OTP) トークンベースの二要素認証。説明 TwoFactorStatus が Enable に設定されている場合は、TwoFactorMethods に上記のいずれかの値を選択する必要があります。	["sms"]
LanguageStatus	string	任意	グローバル設定で指定された言語またはカスタム言語で通知を送信するかどうかを指定します。 Global Custom 説明このパラメーターを空のままにすると、デフォルト値の Global が使用されます。	Custom
Language	string	任意	このパラメーターは、LanguageStatus が Custom に設定されている場合に必須です。有効な値： zh-cn：簡体字中国語。 en：英語。	en

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

リクエストの例の詳細については、「リクエストの例」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスデータ。
UserId	string	追加されたユーザーの ID。	1
RequestId	string	リクエスト ID。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

例

成功レスポンス

JSONJSON

{
  "UserId": "1",
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter	The argument is invalid.
400	UserAlreadyExists	The user already exists.
500	InternalError	An unknown error occurred.

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

変更履歴

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