DescribeEnvironment - 查询环境详情 - 应用实时监控服务ARMS

查询环境详情。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:DescribeEnvironment	get	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
EnvironmentId	string	是	环境实例 ID。	env-xxxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	状态码。200 为成功，其他状态码为异常。	200
Data	object	返回结构体。
EnvironmentId	string	环境实例 ID。	env-xxxxx
EnvironmentType	string	环境类型： CS：容器服务。 ECS。 Cloud：云服务。	CS
EnvironmentName	string	环境名称。	env1
EnvironmentSubType	string	环境的子类型： CS：目前支持 ACK。 ECS：目前支持 ECS。 Cloud：目前支持 Cloud。	ACK
RegionId	string	地域 id	cn-hangzhou
UserId	string	用户 Id。	13002222xxxx
BindResourceId	string	环境绑定的资源实例 ID，包括容器实例 ID 或 VpcId。	vpc-xxxxx
BindResourceType	string	绑定的资源类型。	ECS
BindResourceStatus	string	绑定资源的状态。	running
BindResourceProfile	string	绑定资源的 Profile。	Default
BindVpcCidr	string	绑定 vpc 的网段。	192.168.0.0/16
PrometheusInstanceId	string	绑定的 prometheus 实例 ID。	xxxxyyyyyzzzzz
PrometheusInstanceName	string	绑定的 prometheus 实例名称。	name1
GrafanaWorkspaceId	string	grafana 工作区 id	grafana-cn-i7m2qn9xa01
GrafanaFolderUid	string	Grafana 目录唯一 ID。	xyz
GrafanaDatasourceUid	string	Grafana 数据源唯一 ID。	zuvw
VpcId	string	VPC ID。	vpc-8vb02uk57qbcktqcvqqqj
GrafanaFolderUrl	string	Grafana 目录 URL。	https://g.console.aliyun.com/dashboards/f/xxx/yyyy
BindResourceStoreDuration	string	绑定资源的保存时长(天)。	15
GrafaDataSourceName	string	Grafana 数据源名称。	datasource1
GrafanaFolderTitle	string	Grafana 目录名。	folder1
ManagedType	string	托管类型： none：非托管。ACK 集群的默认值。 agent：托管 agent（含 ksm）。ASK、ACS、AckOne 集群的默认值。 agent-exproter：托管 agent 和 exporter。云服务类型的默认值。	none
FeePackage	string	付费套餐。 EnvironmentType 为 CS 时：可选为 CS_Basic 或 CS_Pro。 EnvironmentType 为其它值时，为空值。枚举值： CS_Pro：容器监控Pro版。 CS_Basic：容器监控基础版。	CS_Basic
DbInstanceStatus	string	绑定 prometheus 实例的 db 状态。枚举值： UNINSTALLING：UNINSTALLING。 INSTALLING：INSTALLING。 UNINSTALLED：UNINSTALLED。 RUNNING：RUNNING。 MODIFYING：MODIFYING。	RUNNING
SecurityGroupId	string	环境绑定的安全组 Id	sg-8vbdgmf4nraiqa9bx0jo
VswitchId	string	环境绑定的交换机 Id	vsw-2ze7yr3f1x8snryaioo7u
ResourceGroupId	string	资源组 ID。	rg-aek2vezare****
Tags	array<object>	标签。
tags	object	标签。
Key	string	Tag 的键。	user1
Value	string	Tag 的值	p_运维
Message	string	返回结果的提示信息。	message

示例

正常返回示例

JSON格式

{
  "RequestId": "C21AB7CF-B7AF-410F-BD61-82D1567F****",
  "Code": 200,
  "Data": {
    "EnvironmentId": "env-xxxxx",
    "EnvironmentType": "CS",
    "EnvironmentName": "env1",
    "EnvironmentSubType": "ACK",
    "RegionId": "cn-hangzhou",
    "UserId": "13002222xxxx",
    "BindResourceId": "vpc-xxxxx",
    "BindResourceType": "ECS",
    "BindResourceStatus": "running",
    "BindResourceProfile": "Default",
    "BindVpcCidr": "192.168.0.0/16",
    "PrometheusInstanceId": "xxxxyyyyyzzzzz",
    "PrometheusInstanceName": "name1",
    "GrafanaWorkspaceId": "grafana-cn-i7m2qn9xa01",
    "GrafanaFolderUid": "xyz",
    "GrafanaDatasourceUid": "zuvw",
    "VpcId": "vpc-8vb02uk57qbcktqcvqqqj",
    "GrafanaFolderUrl": "https://g.console.aliyun.com/dashboards/f/xxx/yyyy",
    "BindResourceStoreDuration": "15",
    "GrafaDataSourceName": "datasource1",
    "GrafanaFolderTitle": "folder1",
    "ManagedType": "none",
    "FeePackage": "CS_Basic",
    "DbInstanceStatus": "RUNNING",
    "SecurityGroupId": "sg-8vbdgmf4nraiqa9bx0jo",
    "VswitchId": "vsw-2ze7yr3f1x8snryaioo7u",
    "ResourceGroupId": "rg-aek2vezare****",
    "Tags": [
      {
        "Key": "user1",
        "Value": "p_运维"
      }
    ]
  },
  "Message": "message"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-07-10	OpenAPI 返回结构发生变更	查看变更详情
2024-07-03	OpenAPI 返回结构发生变更	查看变更详情
2024-05-28	OpenAPI 返回结构发生变更	查看变更详情
2024-03-19	OpenAPI 返回结构发生变更	查看变更详情
2024-02-28	OpenAPI 返回结构发生变更	查看变更详情
2024-01-29	OpenAPI 返回结构发生变更	查看变更详情
2023-11-03	OpenAPI 返回结构发生变更	查看变更详情