ListEnvironments - Managed Service for Prometheus - Alibaba Cloud ドキュメントセンター

環境を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnvironmentType	string	任意	環境タイプ。 AddonName パラメーターと EnvironmentType パラメーターの少なくとも一方を指定する必要があります。有効な値： CS ： Container Service for Kubernetes (ACK) ECS ： Elastic Compute Service (ECS) Cloud ：クラウドサービス列挙値: CS ：コンテナサービス ECS ： ECS サービス Cloud ：クラウドサービス	CS
RegionId	string	任意	リージョン ID。	cn-hangzhou
AddonName	string	任意	アドオン名。 AddonName パラメーターと EnvironmentType パラメーターの少なくとも一方を指定する必要があります。	trace-java
ResourceGroupId	string	任意	リソースグループの ID。	rg-aekzfurdatohtka
Tag	array<object>	任意	タグ。
	object	任意	リソースタグ値。
Key	string	任意	タグキー。	env
Value	string	任意	タグ値。	gfn_web_outbound_add
BindResourceId	string	任意	リソースの ID。	cb9229c48e41144dc96af190841808cb0
FeePackage	string	任意	有料リソースプラン。 EnvironmentType パラメーターが CS に設定されている場合、値を CS_Basic または CS_Pro に設定します。デフォルト値： CS_Basic。それ以外の場合は、パラメーターを空のままにします。有効な値： CS_Pro：コンテナモニタリングプロ版 CS_Basic：コンテナモニタリングベーシック版列挙値: CS_Pro ：コンテナモニタリングプロ版 CS_Basic ：コンテナモニタリングベーシック版	CS_Pro
FilterRegionIds	string	任意	照会するリージョン ID。	cn-beijing,cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	応答
RequestId	string	リクエスト ID。	1A9C645C-C83F-4C9D-8CCB-29BEC9E1****
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true および false。	true
Code	integer	HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。	200
Message	string	返されたメッセージ。	success
Data	object	返された構造体。
Environments	array<object>	照会された環境。
	array<object>	環境の詳細。
Addons	array<object>	アドオン。
	object	アドオンの詳細。
Alias	string	アドオンのエイリアス。	Prometheus プローブ
Description	string	アドオンの説明。	Prometheus の収集仕様に基づいてメトリックデータを収集します
Icon	string	アイコンの URL。	http://xxxx
Name	string	アドオンの名前。	metric-agent
UserId	string	ユーザー ID。	13990957477389
BindResourceId	string	環境インスタンスにバインドされているリソースの ID。リソースには、Kubernetes クラスターまたは VPC を指定できます。	vpc-bp1bgo8ronn
BindResourceProfile	string	リソースにバインドされているプロファイル。	xxx
BindResourceType	string	リソースタイプ。	VPC
BindVpcCidr	string	VPC にバインドされている CIDR ブロック。	172.16.0.0/12
CreateTime	string	環境インスタンスが作成された時間。	2023-03-24 11:58:35 +0800
CreatedUserId	string	ユーザー ID。	12378523784982
EnvironmentId	string	環境インスタンスの ID。	env-xxx
EnvironmentName	string	環境インスタンスの名前。	feiliks-biz-prod-edas
EnvironmentType	string	環境インスタンスのタイプ。有効な値： CS：コンテナサービス ECS： Elastic Compute Service Cloud：クラウドサービス列挙値: CS ：コンテナサービス ECS ： ECS サービス Cloud ：クラウドサービス	CS
Features	array<object>	機能のパラメーターです。
	object	特徴量の詳細。
Alias	string	特徴量のエイリアス。	Prometheus プローブ
Description	string	機能の説明です。	Prometheus の収集仕様に基づいてメトリックデータを収集します
Icon	string	アイコンの URL。	http://xxx
Name	string	特徴量の名前。	metirc-agent
GrafanaFolderTitle	string	Grafana ディレクトリの名前。	filepath
GrafanaFolderUid	string	Grafana ディレクトリの一意の ID。	1798319482935
PrometheusId	integer	Prometheus ID。	124769812
PrometheusInstanceId	string	Prometheus インスタンスの ID。	vpc-m5e4alj2i24ndbn
RegionId	string	リージョン ID。	cn-zhangjiakou
ResourceGroupId	string	リソースグループの ID。	rg-acfmvt3xpr5aema
Tags	array<object>	環境リソースのタグ。
	object	リソースタグ値。
Key	string	タグキー。	fpx-tag
Value	string	タグ値。	cn-beijing
GrafanaDatasourceUid	string	Grafana データソースの一意の ID。	12374890
ReleaseCount	integer	インストールされているアドオンの数。	122
LatestReleaseCreateTime	string	最後のアドオンが作成された時間。	2023-09-22T16:56:29+08:00
ManagedType	string	エージェントまたはエクスポーターが管理されているかどうかを示します。有効な値： none：いいえ。デフォルトでは、ACK クラスターには管理対象のエージェントやエクスポーターは提供されません。 agent：エージェントは管理されます。デフォルトでは、ASK クラスター、ACS クラスター、および ACK One クラスターに管理対象エージェントが提供されます。 agent-exproter：エージェントとエクスポーターは管理されます。デフォルトでは、クラウドサービスに管理対象のエージェントとエクスポーターが提供されます。	agent
FeePackage	string	有料リソースプラン。 EnvironmentType パラメーターが CS に設定されている場合、値は CS_Basic または CS_Pro になります。それ以外の場合は、パラメーターを空のままにします。	CS_Pro
Total	integer	返されたエントリの総数。	12

例

成功レスポンス

JSONJSON

{
  "RequestId": "1A9C645C-C83F-4C9D-8CCB-29BEC9E1****",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "Data": {
    "Environments": [
      {
        "Addons": [
          {
            "Alias": "Prometheus プローブ",
            "Description": "Prometheus の収集仕様に基づいてメトリックデータを収集します",
            "Icon": "http://xxxx",
            "Name": "metric-agent"
          }
        ],
        "UserId": "13990957477389",
        "BindResourceId": "vpc-bp1bgo8ronn",
        "BindResourceProfile": "xxx",
        "BindResourceType": "VPC",
        "BindVpcCidr": "172.16.0.0/12",
        "CreateTime": "2023-03-24 11:58:35 +0800",
        "CreatedUserId": "12378523784982",
        "EnvironmentId": "env-xxx",
        "EnvironmentName": "feiliks-biz-prod-edas",
        "EnvironmentType": "CS",
        "Features": [
          {
            "Alias": "Prometheus プローブ",
            "Description": "Prometheus の収集仕様に基づいてメトリックデータを収集します",
            "Icon": "http://xxx",
            "Name": "metirc-agent"
          }
        ],
        "GrafanaFolderTitle": "filepath",
        "GrafanaFolderUid": "1798319482935",
        "PrometheusId": 124769812,
        "PrometheusInstanceId": "vpc-m5e4alj2i24ndbn",
        "RegionId": "cn-zhangjiakou",
        "ResourceGroupId": "rg-acfmvt3xpr5aema",
        "Tags": [
          {
            "Key": "fpx-tag",
            "Value": "cn-beijing"
          }
        ],
        "GrafanaDatasourceUid": "12374890",
        "ReleaseCount": 122,
        "LatestReleaseCreateTime": "2023-09-22T16:56:29+08:00",
        "ManagedType": "agent",
        "FeePackage": "CS_Pro"
      }
    ],
    "Total": 12
  }
}

エラーコード

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

変更履歴

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