すべてのプロダクト
Search

このプロダクト

    :UpdateInstance

    ドキュメントセンター

    :UpdateInstance

    最終更新日:Dec 21, 2025

    ApsaraMQ for RocketMQ インスタンスの基本情報と仕様を更新します。

    操作説明

    説明

    Alibaba Cloud が提供する API 操作は、Alibaba Cloud サービスのリソースを管理およびクエリするために使用されます。これらの API 操作は管理システムにのみ統合することを推奨します。メッセージングサービスのコアシステムではこれらの API 操作を使用しないでください。使用した場合、システムリスクが発生する可能性があります。

    今すぐお試しください

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

    update

    *Instance

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

    		 なし なし

    リクエスト構文

    PATCH /instances/{instanceId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    基本情報と仕様を更新するインスタンスの ID。

    rmq-cn-7e22ody****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    body

    object

    任意

    リクエストボディ。

    instanceName

    string

    任意

    更新後のインスタンス名。

    test_instance
    remark

    string

    任意

    更新後のインスタンスの説明。

    This is the remark for test.
    networkInfo

    object

    任意

    更新後のインスタンスのネットワーク情報。

    internetInfo

    object

    任意

    インスタンスへのアクセスに使用されるインターネットに関する情報。このパラメーターは、インスタンスでインターネットアクセス機能が有効になっている場合にのみ有効です。

    ipWhitelist

    array

    任意

    インターネット経由で ApsaraMQ for RocketMQ ブローカーへのアクセスを許可する IP アドレスを含むホワイトリスト。

    • IP アドレスホワイトリストを設定しない場合、すべての CIDR ブロックがインターネット経由で ApsaraMQ for RocketMQ ブローカーにアクセスできます。

    • IP アドレスホワイトリストを設定した場合、ホワイトリスト内の IP アドレスのみがインターネット経由で ApsaraMQ for RocketMQ ブローカーにアクセスできます。

    string

    任意

    ホワイトリスト内の IP アドレス。

    192.168.x.x/24
    productInfo

    object

    任意

    インスタンスの追加設定。

    sendReceiveRatio

    number

    任意

    インスタンスで送信可能なメッセージ数と受信可能なメッセージ数の比率。

    有効な値：0.25～1。

    0.5
    autoScaling

    boolean

    任意

    インスタンスの弾性 TPS (Transactions Per Second) 機能を有効にするかどうかを指定します。

    有効な値：

    • true

    • false

    ApsaraMQ for RocketMQ インスタンスで弾性 TPS 機能を有効にすると、仕様上限を超える特定の TPS 数を使用できます。弾性 TPS 機能の使用は課金対象となります。詳細については、「コンピューティング料金」をご参照ください。

    説明

    弾性 TPS 機能は、特定のインスタンスエディションでのみサポートされています。詳細については、「インスタンスエディション」をご参照ください。

    列挙値:

    • true :

      弾性を有効にする

    • false :

      弾性を無効にする

    true
    messageRetentionTime

    integer

    任意

    メッセージの保持期間。単位：時間。

    このパラメーターの有効な値については、「制限」トピックの「リソースクォータの制限」セクションをご参照ください。

    ApsaraMQ for RocketMQ は、メッセージストレージのサーバーレススケーリングをサポートしています。実際のストレージ使用量に基づいてストレージ料金が課金されます。メッセージの保持期間を変更して、ストレージ容量を管理できます。詳細については、「ストレージ料金」をご参照ください。

    72
    traceOn

    boolean

    任意

    メッセージトレース機能を有効にするかどうかを指定します。

    • true

    • false

    このパラメーターは使用されていません。このパラメーターが設定されているかどうかに関わらず、デフォルトで ApsaraMQ for RocketMQ インスタンスのメッセージトレース機能は有効になっています。

    列挙値:

    • false :

      メッセージトレース機能を無効にする

    • true :

      メッセージトレース機能を有効にする

    true
    aclInfo

    object

    任意

    インスタンスのアクセス制御リスト。

    aclTypes

    array

    任意

    インスタンスの認証タイプ。

    string

    任意

    インスタンスの認証タイプ。

    有効な値：

    • default：インテリジェント ID 認証

    • apache_acl：アクセス制御リスト (ACL) ID 認証

    列挙値:

    • default :

      インテリジェント ID 認証

    • apache_acl :

      Apache RocketMQ ACL

    apache_acl
    defaultVpcAuthFree

    boolean

    任意

    VPC 内での認証不要機能が有効になっているかどうかを示します。 有効な値：

    • true

    • false

    列挙値:

    • true :

      パスワードなしのアクセスを有効にする

    • false :

      パスワードなしのアクセスを無効にする

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    requestId

    string

    リクエスト ID。システムはリクエストごとに一意の ID を生成します。このリクエスト ID に基づいて問題をトラブルシューティングできます。

    AA87DE09-DA44-52F4-9515-78B1B607****
    success

    boolean

    呼び出しが成功したかどうかを示します。

    true
    data

    boolean

    返される結果データ。

    true
    code

    string

    エラーコード。

    MissingInstanceId
    message

    string

    エラーメッセージ。

    Parameter instanceId is mandatory for this action .
    httpStatusCode

    integer

    HTTP ステータスコード。

    400
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "AA87DE09-DA44-52F4-9515-78B1B607****",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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