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

Application Real-Time Monitoring Service:CreateEnvServiceMonitor

最終更新日:Apr 11, 2026

環境の ServiceMonitor を作成します。

今すぐお試しください

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

create

*Environment

acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID。

cn-hangzhou

AliyunLang

string

任意

言語。有効な値:

  • zh (デフォルト): 中国語

  • en: 英語

列挙値:

  • en :

    en

  • zh :

    zh

zh

EnvironmentId

string

必須

環境インスタンスの ID。

env-xxxxxx

DryRun

boolean

任意

リクエストを実際には実行せず、ドライランのみを実行するかどうかを指定します。システムは、フォーマットの有効性とターゲットの一致性をチェックします。

true

ConfigYaml

string

必須

ServiceMonitor の YAML 設定ファイル。

参见补充说明。

ConfigYAML の例:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: arms-admin1
  namespace: arms-prom
  annotations:
    arms.prometheus.io/discovery: 'true'
spec:
  endpoints:
  - interval: 30s
    port: operator
    path: /metrics
  - interval: 10s
    port: operator1
    path: /metrics
  namespaceSelector:
    any: true
  selector:
    matchLabels:
     app: arms-prometheus-ack-arms-prometheus

ServiceMonitor を有効にするには、arms.prometheus.io/discovery を指定し、値を true に設定する必要があります。

レスポンスフィールド

フィールド

説明

object

応答のスキーマ

RequestId

string

リクエスト ID。

78901766-3806-4E96-8E47-CFEF59E4****

Code

integer

HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。

200

Data

object

返される構造体。

MatchedMsg

string

ターゲットが一致したかどうかを示します。

匹配成功。

Namespace

string

名前空間。

arms-prom

ServiceMonitorName

string

作成された ServiceMonitor の名前。

arms-admin1

MatchedTargetCount

integer

一致したターゲットの数。

1

Message

string

返されるメッセージ。

message

成功レスポンス

JSONJSON

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Code": 200,
  "Data": {
    "MatchedMsg": "匹配成功。",
    "Namespace": "arms-prom",
    "ServiceMonitorName": "arms-admin1",
    "MatchedTargetCount": 1
  },
  "Message": "message"
}

エラーコード

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

変更履歴

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