すべてのプロダクト
Search
ドキュメントセンター

Application Real-Time Monitoring Service:CreatePrometheusInstance

最終更新日:Jun 24, 2026

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

arms:CreatePrometheusInstance

create

*Prometheus

acs:arms:{#regionId}:{#accountId}:prometheus/*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

実際のリージョンID。

cn-shanghai

ClusterType

string

必須

インスタンスタイプ。有効な値:

  • remote-write:Prometheus Remote Write。

  • ecs(サポート終了):Prometheus ECS。

  • global-view:Prometheus GlobalView。

  • aliyun-cs(サポート終了):Prometheusコンテナサービス。

  • cloud-product(サポート終了):Prometheusクラウドサービス。

  • cloud-monitor(サポート終了):Prometheusハイブリッドクラウドモニタリング。

  • flink(サポート終了):Prometheus Flink。

remote-write

VpcId

string

任意

VPC ID。ClusterTypeがecsまたはaliyun-cs(マネージドASKクラスター)に設定されている場合に必須です。

vpc-rpn**********

VSwitchId

string

任意

vSwitch ID。ClusterTypeがecsまたはaliyun-cs(マネージドASKクラスター)に設定されている場合に必須です。

vsw-bp1*********

SecurityGroupId

string

任意

セキュリティグループID。ClusterTypeがecsまたはaliyun-cs(マネージドASKクラスター)に設定されている場合に必須です。

sg-bp1********

ClusterId

string

任意

コンテナサービスクラスターID。ClusterTypeがaliyun-csに設定されている場合に必須です。

cc7a37ee31aea4ed1a059eff8034b****

ClusterName

string

任意

作成するクラスターの名前。ClusterTypeがremote-write、ecs、またはglobal-viewに設定されている場合に必須です。

ECSインスタンスの場合、ClusterNameは「name-vpc-id」の形式に従う必要があり、name 部分は24 文字を超えることはできません。例:「mytest1-vpc-xxxxxxxxxxx」。

clusterNameOfTest

SubClustersJson

string

任意

GlobalViewインスタンスのサブインスタンスのJSON 文字列。

当clusterType为global-view时,需要传此参数:需要聚合的集群的信息列表;示例: [ { "headers":{ }, "regionId":"cn-hangzhou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c39a1048921e04f***********", "sourceName":"arms-luyao-test", "dataSource":"", "userId":"1672753***********" }, { "headers":{ }, "regionId":"cn-beijing", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c6b6485496d5b40***********", "sourceName":"agent-321-测试", "dataSource":"", "userId":"1672753***********" }, { "headers":{ }, "regionId":"cn-zhangjiakou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c261a4f3200c446***********", "sourceName":"zaifeng-cardinality-01", "dataSource":"", "userId":"1672753***********" } ]

AllSubClustersSuccess

boolean

任意

GlobalViewインスタンスを作成する前に、すべてのサブインスタンスが検証に合格する必要があるかどうかを指定します。デフォルト値:false(部分的な成功が許可されます)。

true

GrafanaInstanceId

string

任意

バインドされたGrafanaワークスペースのID。共有 Grafanaエディションを使用する場合は、このパラメーターを「free」に設定します。

grafana-bp1*****

ResourceGroupId

string

任意

リソースグループID。

rg-acfmxyexli2****

Tags

array<object>

任意

カスタムタグ。

[ { "labelName":"labelValue" }, { "testName":"clusterA" } ]

object

任意

タグのリスト。

Key

string

任意

タグキー。

TestKey

Value

string

任意

タグ値。

TestValue

Duration

integer

任意

データ保存期間(日単位)。

90

ArchiveDuration

integer

任意

保存期間終了後にデータを自動アーカイブする日数。有効な値:60、90、180、365。値が0の場合、データはアーカイブされません。

90

PaymentType

string

任意

課金方式。有効な値: POSTPAY:レポートされたメトリクス数に基づく従量課金。 POSTPAY_GB:書き込まれたメトリクス量に基づく従量課金。 空:ユーザーが設定したデフォルトの課金方式を使用します。デフォルトが設定されていない場合、システムはレポートされたメトリクス数に基づく課金をデフォルトとします。

POSTPAY

レスポンスフィールド

フィールド

説明

object

Data

string

インスタンス作成後に返されるインスタンスID。

  • aliyun-csインスタンスの場合、PrometheusインスタンスIDはコンテナサービスクラスターIDです。

  • ecsインスタンスの場合、PrometheusインスタンスIDはVPC IDです。

qduukd****

RequestId

string

リクエストID。

70675725-8F11-4817-8106-CFE0AD71****

Message

string

返されたメッセージ。

message

Code

integer

HTTPステータスコード。有効な値:

  • 2XX:成功。

  • 3XX:リダイレクト。

  • 4XX:リクエストエラー。

  • 5XX:サーバーエラー。

200

成功レスポンス

JSONJSON

{
  "Data": "qduukd****",
  "RequestId": "70675725-8F11-4817-8106-CFE0AD71****",
  "Message": "message",
  "Code": 200
}

エラーコード

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

変更履歴

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