すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:UpdateInstanceAccount

    ドキュメントセンター

    ApsaraMQ for RocketMQ:UpdateInstanceAccount

    最終更新日:Apr 27, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rocketmq:UpdateInstanceAccount

    update

    *Instance

    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエスト構文

    PATCH /instances/{instanceId}/accounts/{username} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンスの ID です。

    rmq-cn-7e22ody****
    username

    string

    必須

    アカウントの名前。

    test

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    accountStatus

    string

    任意

    アカウントのステータスです。

    列挙値:

    • DISABLE :

      アカウントを無効化します。

    • ENABLE :

      アカウントを有効化します。

    ENABLE
    password

    string

    任意

    アカウントのパスワードです。

    test
    remark

    string

    任意

    アカウントの備考です。

    test

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リクエストに対して返されるデータです。

    requestId

    string

    リクエストの ID です。

    AF9A8B10-C426-530F-A0DD-96320B39****
    success

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    boolean

    更新が成功したかどうかを示します。更新が成功した場合、値は true になります。

    true
    code

    string

    リクエストが失敗した場合に返されるエラーコードです。

    Instance.NotFound
    message

    string

    リクエストが失敗した場合に返されるエラーメッセージです。

    The instance cannot be found.
    httpStatusCode

    integer

    HTTP ステータスコードです。

    200
    dynamicCode

    string

    動的エラーコードです。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージです。

    instanceId
    accessDeniedDetail

    string

    アクセス拒否に関する詳細情報です。このパラメーターは、RAM 権限が不十分なためにリクエストが拒否された場合にのみ返されます。

    xxx

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "Instance.NotFound",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

    エラーコード

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

    変更履歴

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