インスタンスの名前と説明の更新 - ApsaraMQ for RocketMQ

操作説明

重要 Alibaba Cloud が提供する OpenAPI は管理 API です。この API を使用して、Alibaba Cloud サービスのリソースを管理およびクエリできます。OpenAPI は管理目的でのみ統合してください。メッセージを送受信するコアデータリンクには 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:UpdateInstance

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

なし

mq:QueryInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Remark	string	任意	インスタンスの更新後の説明。このパラメーターを空のままにすると、説明は更新されません。	备注更新
InstanceName	string	任意	インスタンスの更新後の名前。名前は次の要件を満たす必要があります：インスタンスがデプロイされているリージョン内で一意である必要があります。長さは 3～64 文字で、中国語文字、英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。このパラメーターを空のままにすると、名前は更新されません。	名字更新
InstanceId	string	必須	名前または説明を更新するインスタンスの ID。	MQ_INST_188077086902****_BXSuW61e

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。この ID は各リクエストに一意です。この ID を使用して、問題の特定やトラブルシューティングを行います。	A07E3902-B92E-44A6-B6C5-6AA111111****

例

成功レスポンス

JSONJSON

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

エラーコード

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

変更履歴

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