すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:UpdateInstance

    ドキュメントセンター

    ApsaraMQ for RocketMQ:UpdateInstance

    最終更新日:Jul 23, 2026

    ApsaraMQ for RocketMQ インスタンスの基本情報および仕様設定を更新します。

    操作説明

    重要 Alibaba Cloud が提供する OpenAPI は、Alibaba Cloud サービスのリソースを管理およびクエリするための管理コントロール API です。管理コントロールリンクでの統合にのみ使用することを推奨します。メッセージの送受信を行うコアデータリンクで OpenAPI を使用することは固く禁じられています。使用した場合、リンクにリスクが発生する可能性があります。

    今すぐお試しください

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

    任意

    パブリックアクセス用の IP アドレスホワイトリストです。

    • IP アドレスホワイトリストを設定しない場合、デフォルトで任意のパブリック IP アドレスからのアクセスが許可されます。

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

    string

    任意

    パブリック IP アドレスホワイトリスト内の IP アドレスまたは CIDR ブロックです。

    192.168.x.x/24
    productInfo

    object

    任意

    インスタンスの拡張設定。

    sendReceiveRatio

    number

    任意

    メッセージの送信と受信の比率。

    有効な値: [0.25, 1]

    0.5
    autoScaling

    boolean

    任意

    仕様を超えるバースト可能な弾力キャパシティを有効にするかどうかを指定します。

    バースト可能な弾力キャパシティを有効にすると、ApsaraMQ for RocketMQ はインスタンスが一定の有効値内で基本仕様の TPS 制限を超えることを許可します。基本仕様を超える部分には、追加の弾力仕様料金が発生します。課金の詳細については、「コンピューティング料金」をご参照ください。

    説明

    バースト可能な弾力キャパシティをサポートするのは特定の仕様のインスタンスのみです。サポートされているインスタンスの詳細については、「インスタンスの仕様」をご参照ください。

    列挙値:

    • true :

      弾力的スケーリングを有効にします。

    • false :

      弾力的スケーリングを無効にします。

    true。
    messageRetentionTime

    integer

    任意

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

    有効値の範囲については、「使用制限」>「リソースクォータ」>「メッセージ保持期間」をご参照ください。

    ApsaraMQ for RocketMQ のログブローカーは完全なサーバーレスおよび弾力的であり、実際のストレージスペースに基づいて料金が発生します。メッセージ保持期間を調整することで、メッセージのストレージ容量をコントロールできます。詳細については、「ストレージ料金」をご参照ください。

    72
    traceOn

    boolean

    任意

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

    このパラメーターは効果はありません。このパラメーターが有効かどうかに関わらず、インスタンスはデフォルトでトレース特徴をサポートします。

    列挙値:

    • false :

      メッセージトレース特徴を無効にします。

    • true :

      メッセージトレース特徴を有効にします。

    true。
    adaptiveElasticity

    boolean

    任意

    aclInfo

    object

    任意

    アクセスの制御情報。

    aclTypes

    array

    任意

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

    string

    任意

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

    列挙値:

    • default :

      インテリジェント ID 認識。

    • apache_acl :

      Apache RocketMQ ACL。

    apache_acl。
    defaultVpcAuthFree

    boolean

    任意

    インテリジェント ID 認識タイプにおいて、VPC 接続の認証なしアクセスが有効かどうかを示します。

    列挙値:

    • true :

      認証なしアクセスを有効にします。

    • false :

      認証なしアクセスを無効にします。

    false。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<ブール値>

    requestId

    string

    リクエスト ID。各リクエスト ID は一意であり、トラブルシューティングおよび問題の特定にアクティブなものです。

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

    boolean

    実行が成功したかどうかを示します。

    true。
    data

    boolean

    返された結果。

    true。
    code

    string

    エラーコード。

    MissingInstanceId。
    message

    string

    エラーメッセージ。

    このアクションにはパラメーター instanceId が必須です。
    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"
}

    エラーコード

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

    変更履歴

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