すべてのプロダクト
Search

このプロダクト

    Bastionhost:ModifyUser

    ドキュメントセンター

    Bastionhost:ModifyUser

    最終更新日:Jan 21, 2026

    踏み台ホストのユーザー情報を変更します。

    今すぐお試しください

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

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    ユーザー情報を変更する踏み台ホストの ID。

    説明

    DescribeInstances 操作を呼び出して、踏み台ホストの ID を照会できます。

    bastionhost-cn-st220aw****
    RegionId

    string

    任意

    ユーザー情報を変更する踏み台ホストのリージョン ID。

    説明

    リージョン ID とリージョン名のマッピングの詳細については、「リージョンとゾーン」をご参照ください。

    cn-hangzhou
    UserId

    string

    必須

    情報を変更するユーザーの ID。

    説明

    ListUsers 操作を呼び出して、ユーザー ID を照会できます。

    1
    Password

    string

    任意

    ユーザーの新しいパスワード。パスワードは 8～128 文字である必要があります。大文字、小文字、数字、特殊文字を含める必要があります。

    説明

    ユーザーのパスワードを変更しない場合、このパラメーターは指定不要です。

    321****
    DisplayName

    string

    任意

    ユーザーの新しい表示名。表示名は 128 文字以内で指定します。

    説明

    ユーザーの表示名を変更しない場合、このパラメーターは指定不要です。

    Bob
    Comment

    string

    任意

    ユーザーの新しいコメント。コメントは 500 文字以内で指定します。

    説明

    ユーザーのコメントを変更しない場合、このパラメーターは指定不要です。

    comment
    Email

    string

    任意

    ユーザーの新しいメールアドレス。

    説明

    • 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 操作を呼び出して、グローバル二要素認証設定を照会できます。

    • ユーザーの携帯電話番号を変更しない場合、このパラメーターは指定不要です。

    1358888****
    MobileCountryCode

    string

    任意

    ユーザーの新しい携帯電話番号が登録されている国。有効な値：

    • CN：中国本土、国番号は +86

    • HK：香港 (中国)、国番号は +852

    • MO：マカオ (中国)、国番号は +853

    • TW：台湾 (中国)、国番号は +886

    • RU：ロシア、国番号は +7

    • SG：シンガポール、国番号は +65

    • MY：マレーシア、国番号は +60

    • ID：インドネシア、国番号は +62

    • DE：ドイツ、国番号は +49

    • AU：オーストラリア、国番号は +61

    • US：米国、国番号は +1

    • AE：アラブ首長国連邦、国番号は +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

    説明

    ユーザーのパスワードリセット設定を変更しない場合、このパラメーターは指定不要です。

    true
    TwoFactorStatus

    string

    任意

    ユーザーに対して二要素認証を有効にするかどうかを指定します。有効な値：

    • Global：グローバル設定が適用されます。

    • Disable：二要素認証は無効です。

    • Enable：二要素認証が有効になり、ユーザー固有の設定が適用されます。

    説明

    ユーザーの二要素認証設定を変更しない場合、このパラメーターは指定不要です。

    Enable
    TwoFactorMethods

    string

    任意

    二要素認証のメソッド。1 つのメソッドのみ選択できます。有効な値：

    • sms：ショートメッセージベースの二要素認証。

    • email：メールベースの二要素認証。

    • dingtalk：DingTalk ベースの二要素認証。

    • totp：ワンタイムパスワード (OTP) トークンベースの二要素認証。

    説明

    TwoFactorStatus が Enable に設定されている場合は、有効な値のいずれかを TwoFactorMethods として指定する必要があります。

    [ "sms" ]
    LanguageStatus

    string

    任意

    グローバル設定で指定された言語またはカスタム言語で通知を送信するかどうかを指定します。

    • Global

    • Custom

    説明

    ユーザーに通知するために使用される自然言語を変更しない場合、このパラメーターは指定不要です。

    Custom
    Language

    string

    任意

    このパラメーターは、LanguageStatus が Custom に設定されている場合に必須です。

    • zh-cn：簡体字中国語

    • en：英語

    en

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    RequestId

    string

    リクエスト ID。問題を特定し、トラブルシューティングするために使用されます。

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParameter The argument is invalid.
    500 InternalError An unknown error occurred.
    404 UserNotFound The user is not found.

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

    変更履歴

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