RocketMQ モニタリングメタデータ向け ListMetricMeta API リファレンス - ApsaraMQ for RocketMQ

モニタリング項目リストを照会します。

今すぐお試しください

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

list

*All Resource

*

なし

リクエスト構文

GET /monitor/metrics/meta HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
pageNumber	integer	必須	ページ番号。どのページの結果を返すかを示します。	1
pageSize	integer	必須	ページサイズ。1 ページあたりの最大結果数を示します。	10

レスポンスフィールド

フィールド	型	説明	例
	object	Result<MyPage>
requestId	string	リクエスト ID	8B459455-4A35-5796-BA9D-98EF1AB9A931
success	boolean	操作が成功したかどうか	true
data	object	返された結果
pageNumber	integer	現在のページ番号	1
pageSize	integer	ページサイズ	10
totalCount	integer	レコードの総数	1
list	array<object>	ページ分割されたデータ
	object	モニタリング項目のリスト。
metricName	string	モニタリング項目名	SendMessageCountPerInstance
description	string	モニタリング項目の説明	Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project
category	string	モニタリング項目のタグ	Bug
code	string	エラーコード	Topic.NotFound
message	string	エラーメッセージ	The topic already exists.
httpStatusCode	integer	HTTP ステータスコード	200
dynamicCode	string	動的エラーコード	xxx
dynamicMessage	string	動的エラーメッセージ。	xxx

例

成功レスポンス

JSONJSON

{
  "requestId": "8B459455-4A35-5796-BA9D-98EF1AB9A931",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "metricName": "SendMessageCountPerInstance",
        "description": "Using Serverless Devs to deploy the infrastructure of project:get-userinfo-v1-infrastructure-as-template-project",
        "category": "Bug"
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The topic already exists.",
  "httpStatusCode": 200,
  "dynamicCode": "xxx",
  "dynamicMessage": "xxx"
}

エラーコード

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

変更履歴

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