API による Prometheus ビューインスタンスのクエリ - CloudMonitor

Prometheus ビューインスタンスを一覧表示します。

操作説明

Prometheus ビューインスタンスをリスト表示します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cms:ListPrometheusViews

list

*PrometheusView

acs:cms:{#regionId}:{#accountId}:prometheusview/*

なし

リクエスト構文

GET /prometheus-views HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
prometheusViewIds	string	任意	Prometheus ビューインスタンスの ID。	view-xxx
prometheusViewName	string	任意	Prometheus ビューの名前。	view1
workspace	string	任意	ワークスペースの名前。	workspace-test
version	string	任意	インスタンスのバージョン。有効な値：V1 および V2。	V2
resourceType	string	任意	リソースタイプ。	PROMETHEUSVIEW
filterRegionIds	string	任意	結果をフィルターするために使用するリージョン ID。	cn-zhangjiakou,cn-beijing
resourceGroupId	string	任意	リソースグループ ID。	rg-acfm3gn5i6bigbi
tag	array<object>	任意	タグのリスト。
	object	任意	タグのリスト。
key	string	任意	タグキー。	key1
value	string	任意	タグ値。	value1
maxResults	integer	任意	返すレコードの最大数。	100
nextToken	string	任意	クエリトークン。	44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
maxResults	integer	返されたレコードの最大数。	10
nextToken	string	次のクエリに使用するトークン。	2-ba4d-4b9f-aa24-dcb067a30f1c
prometheusViews	array<object>	Prometheus ビューインスタンスのリスト。
	object	Prometheus ビューインスタンス。
createTime	string	インスタンスが作成された時間。時間は UTC で、`yyyy-MM-ddTHH:mmZ` フォーマットです。	2025-07-12T02:18:36Z
instanceType	string	インスタンスタイプ。有効な値は、新バージョンの集約ビューの場合は `prom-view`、旧バージョンの集約ビューの場合は `global-view` です。	prom-view
paymentType	string	課金方法。値は `FREE` に固定されています。	FREE
product	string	Prometheus インスタンスが属するプロダクト。有効な値：`arms` および `cms`。	cms
prometheusInstanceCount	integer	ビュー内の Prometheus インスタンスの数。	2
prometheusViewId	string	Prometheus ビュー ID。	view-xxx
prometheusViewName	string	Prometheus ビューの名前。	view1
regionId	string	リージョン ID。	cn-zhangjiakou
resourceType	string	リソースタイプ。値は `PrometheusView` に固定されています。	PrometheusView
status	string	バックエンドデータストレージのステータス。	Running
userId	string	ユーザー ID。	123xxx
version	string	バージョン。	V2
workspace	string	Prometheus インスタンスが属するワークスペース。	default-cms-1490404746278495-cn-hangzhou
requestId	string	リクエスト ID。	0CEC5375-C554-562B-A65F-9A629907C1F0
totalCount	integer	インスタンスの総数。	66

例

成功レスポンス

JSONJSON

{
  "maxResults": 10,
  "nextToken": "2-ba4d-4b9f-aa24-dcb067a30f1c",
  "prometheusViews": [
    {
      "createTime": "2025-07-12T02:18:36Z",
      "instanceType": "prom-view",
      "paymentType": "FREE",
      "product": "cms",
      "prometheusInstanceCount": 2,
      "prometheusViewId": "view-xxx",
      "prometheusViewName": "view1",
      "regionId": "cn-zhangjiakou",
      "resourceType": "PrometheusView",
      "status": "Running",
      "userId": "123xxx",
      "version": "V2",
      "workspace": "default-cms-1490404746278495-cn-hangzhou"
    }
  ],
  "requestId": "0CEC5375-C554-562B-A65F-9A629907C1F0",
  "totalCount": 66
}

エラーコード

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

変更履歴

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