DescribeEnvironment - Application Real-Time Monitoring Service

Queries the details of an environment.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
arms:DescribeEnvironment	get	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
EnvironmentId	string	Yes	The ID of the environment instance.	env-xxxxx

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	C21AB7CF-B7AF-410F-BD61-82D1567F****
Code	integer	The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.	200
Data	object	The returned struct.
EnvironmentId	string	The ID of the environment instance.	env-xxxxx
EnvironmentType	string	The type of the environment. Valid values: CS: Container Service for Kubernetes (ACK) ECS: Elastic Compute Service Cloud: cloud service	CS
EnvironmentName	string	The environment name.	env1
EnvironmentSubType	string	Environment subtypes: CS: Currently supports ACK. ECS: ECS is currently supported. Cloud: Currently supports Cloud.	ACK
RegionId	string	The region ID.	cn-hangzhou
UserId	string	The user ID.	13002222xxxx
BindResourceId	string	The ID of the resource associated with the environment, such as the ACK cluster ID or VPC ID.	vpc-xxxxx
BindResourceType	string	The resource type.	ECS
BindResourceStatus	string	The status of the resource.	running
BindResourceProfile	string	The profile of the resource.	Default
BindVpcCidr	string	The VPC CIDR block.	192.168.0.0/16
PrometheusInstanceId	string	The ID of the Prometheus instance.	xxxxyyyyyzzzzz
PrometheusInstanceName	string	The name of the Prometheus instance.	name1
GrafanaWorkspaceId	string	The ID of the Grafana workspace.	grafana-cn-27a3m8eem0a
GrafanaFolderUid	string	The unique ID of the Grafana directory.	xyz
GrafanaDatasourceUid	string	The unique ID of the Grafana data source.	zuvw
VpcId	string	The VPC ID.	vpc-8vb02uk57qbcktqcvqqqj
GrafanaFolderUrl	string	The URL of the Grafana directory.	https://g.console.aliyun.com/dashboards/f/xxx/yyyy
BindResourceStoreDuration	string	The retention period of the resource. Unit: days.	15
GrafaDataSourceName	string	The name of the Grafana data source.	datasource1
GrafanaFolderTitle	string	The name of the Grafana directory.	folder1
ManagedType	string	managed type: none: unmanaged. The default value for ACK clusters. agent: managed agent (including KSM). The default values for ASK, ACS, and AckOne clusters. agent-exporter: managed agent and exporters. The default value for the cloud service type.	none
FeePackage	string	The payable resource plan. Valid values: If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro. Otherwise, leave the parameter empty.	CS_Basic
DbInstanceStatus	string	The status of the database that is bound to the Prometheus instance. Valid values: UNINSTALLING INSTALLING UNINSTALLED RUNNING MODIFYING	RUNNING
SecurityGroupId	string	The ID of the security group associated with the environment.	sg-8vbdgmf4nraiqa9bx0jo
VswitchId	string	The ID of the vSwitch associated with the environment.	vsw-2ze7yr3f1x8snryaioo7u
ResourceGroupId	string	The ID of the resource group.	rg-aek2vezare****
Tags	array<object>	The tags.
tags	object	The tag.
Key	string	The tag key.	user1
Value	string	The tag value.	p_dev
Message	string	The returned message.	message

Examples

Sample success responses

JSONformat

{
  "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-27a3m8eem0a",
    "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_dev"
      }
    ]
  },
  "Message": "message"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-10	The response structure of the API has changed	View Change Details
2024-07-03	The response structure of the API has changed	View Change Details
2024-05-28	The response structure of the API has changed	View Change Details
2024-03-19	The response structure of the API has changed	View Change Details
2024-02-28	The response structure of the API has changed	View Change Details
2024-01-29	The response structure of the API has changed	View Change Details
2023-11-03	The response structure of the API has changed	View Change Details