Queries environments.
Debugging
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:ListEnvironments | list |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
EnvironmentType | string | No | The environment type. You must specify at least one of the AddonName and EnvironmentType parameters. Valid values:
Enumeration Value:
| CS |
RegionId | string | No | The region ID. | cn-hangzhou |
AddonName | string | No | The add-on name. You must specify at least one of the AddonName and EnvironmentType parameters. | trace-java |
ResourceGroupId | string | No | The ID of the resource group. | rg-aekzfurdatohtka |
Tag | array<object> | No | The tags. | |
object | No | Resource tag value. | ||
Key | string | No | The tag key. | env |
Value | string | No | The tag value. | gfn_web_outbound_add |
BindResourceId | string | No | The ID of the resource. | cff30f0d67d7542dfb05bd114b4b1d7af |
FeePackage | string | No | The payable resource plan.
Valid values:
| CS_Pro |
FilterRegionIds | string | No | The region IDs. |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "1A9C645C-C83F-4C9D-8CCB-29BEC9E1****",
"Success": true,
"Code": 200,
"Message": "success",
"Data": {
"Environments": [
{
"Addons": [
{
"Alias": "MySQL Exporter",
"Description": "Collect mysql indicator information",
"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 Agent",
"Description": "Collect Metric data using the Prometheus collection specification",
"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
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-07-26 | The request parameters of the API has changed | View Change Details |
2024-05-07 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
2024-01-29 | The request parameters of the API has changed | View Change Details |
2024-01-23 | The response structure of the API has changed | View Change Details |