DescribeEnvironmentFeature - 查询Feature详情 - 应用实时监控服务ARMS

查询Feature详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
EnvironmentId	string	是	环境 ID。	env-xxx
RegionId	string	否	地域 ID。	cn-hangzhou
FeatureName	string	是	Feature 的名称。枚举值： app-agent-pilot : App Pilot 探针 arms-cmonitor : ARMS CMonitor 探针 metric-agent : Prometheus 探针	metric-agent
AliyunLang	string	否	语言参数，en \| zh。	zh

FeatureName 可通过ListEnvironmentFeatures查询可安装的 Feature 信息。

返回参数

名称	类型	描述	示例值
	object	response
RequestId	string	Id of the request	01FF8DD9-A09C-47A1-895A-B6E321BE77B6
Code	integer	状态码。200 表示成功。	200
Message	string	返回结果的提示信息。	success
Success	boolean	查询是否成功：true：成功。 false：失败。	true
Data	object	返回结构体。
Feature	object	Feature 安装信息。
Alias	string	Feature 别名。	Prometheus 探针
Config	object	Feature 配置。
	string	Feature 配置信息。	{}
Description	string	Feature 描述。	以 Prometheus 采集规范采集 Metric 数据。
EnvironmentId	string	环境 ID。	env-xxxxx
Icon	string	图标地址。	http://xxx
Language	string	语言。	zh
LatestVersion	string	最新版本号。	1.1.17
Name	string	Feature 名称。	metric-agent
Status	string	安装状态。 Installing 正在安装 Success 安装成功 Failed 安装失败 UnInstall 已卸载或未安装 UnInstalling 正在卸载 UnInstallFailed 卸载失败枚举值： UnInstall : 未安装或已卸载 Failed : 安装失败 Installing : 正在安装 UnInstallFailed : 卸载失败 Success : 安装成功 UnInstalling : 正在卸载	Success
Version	string	版本。	1.1.17
Managed	boolean	是否为托管组件。
FeatureStatus	object	Feature 的运行状态。
FeatureContainers	array<object>	Feature 的容器列表。
	object	Feature 的容器信息。
Args	array	容器参数。
	string	参数值。	[ "--port=9335", "--yaml=/etc/config/prometheusDisk/prometheus.yaml", "--chartVersion=1.1.17" ]
Image	string	容器镜像。	registry-cn-hangzhou-vpc.ack.aliyuncs.com/acs/arms-prometheus-agent:v4.0.0
Name	string	容器名称。	arms-prometheus-operator
Name	string	Feature 的 K8s 资源名称。	arms-prometheus-ack-arms-prometheus
Namespace	string	命名空间。	arms-prom
Status	string	运行状态。 Success 运行正常 Failed 运行异常 Not Found 未安装枚举值： Failed : 运行异常 Not Found : 未安装 Success : 运行正常	Success
SecurityGroupId	string	安全组 ID。	sg-bp1gbhqh8b4dsgvopkry
VSwitchId	string	交换机 ID。	vsw-uf6vc2e4ytv8vv05j3u09
BindResourceId	string	绑定的资源 ID。	c013823b55e4b4d6bb6b6f28682bd38a7
Ips	array	Pod 的 IP 地址。
	string	对应的 IP。	10.178.176.187
config	string	Feature 的配置信息。	{}

示例

正常返回示例

JSON格式

{
  "RequestId": "01FF8DD9-A09C-47A1-895A-B6E321BE77B6",
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": {
    "Feature": {
      "Alias": "Prometheus 探针",
      "Config": {
        "key": "{}"
      },
      "Description": "以 Prometheus 采集规范采集 Metric 数据。",
      "EnvironmentId": "env-xxxxx",
      "Icon": "http://xxx",
      "Language": "zh",
      "LatestVersion": "1.1.17",
      "Name": "metric-agent",
      "Status": "Success",
      "Version": "1.1.17",
      "Managed": true
    },
    "FeatureStatus": {
      "FeatureContainers": [
        {
          "Args": [
            "[\n    \"--port=9335\",\n    \"--yaml=/etc/config/prometheusDisk/prometheus.yaml\",\n    \"--chartVersion=1.1.17\"\n  ]"
          ],
          "Image": "registry-cn-hangzhou-vpc.ack.aliyuncs.com/acs/arms-prometheus-agent:v4.0.0",
          "Name": "arms-prometheus-operator"
        }
      ],
      "Name": "arms-prometheus-ack-arms-prometheus",
      "Namespace": "arms-prom",
      "Status": "Success",
      "SecurityGroupId": "sg-bp1gbhqh8b4dsgvopkry",
      "VSwitchId": "vsw-uf6vc2e4ytv8vv05j3u09",
      "BindResourceId": "c013823b55e4b4d6bb6b6f28682bd38a7",
      "Ips": [
        "10.178.176.187"
      ]
    },
    "config": "{}"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。