All Products
Search
Document Center

Application Real-Time Monitoring Service:DescribeEnvironmentFeature

Last Updated:Nov 05, 2024

Queries the details of a feature.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
arms:DescribeEnvironmentFeaturenone
  • Environment
    acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnvironmentIdstringYes

The environment ID.

env-xxx
RegionIdstringNo

The region ID.

cn-hangzhou
FeatureNamestringYes

The name of the feature.

Valid values:

  • app-agent-pilot: App Pilot agent
  • arms-cmonitor: ARMS CMonitor agent
  • metric-agent: Prometheus agent
Enumeration Value:
  • app-agent-pilot: Agent of App Pilot.
  • arms-cmonitor: .
  • metric-agent: Agent of Prometheus.
metric-agent
AliyunLangstringNo

The language. Valid values: en and zh.

en

You can call the ListEnvironmentFeatures operation to query the feature information.

Response parameters

ParameterTypeDescriptionExample
object

response

RequestIdstring

The ID of the request.

01FF8DD9-A09C-47A1-895A-B6E321BE77B6
Codeinteger

The HTTP status code. The status code 200 indicates that the request was successful.

200
Messagestring

The returned message.

success
Successboolean

Indicates whether the request was successful. Valid values: true and false.

true
Dataobject

The returned struct.

Featureobject

The installation information about the feature.

Aliasstring

The alias of the feature.

Prometheus agent.
Configobject

The configuration of the feature.

string

The configuration of the feature.

{}
Descriptionstring

The description of the feature.

Collect Metric data using the Prometheus collection specification.
EnvironmentIdstring

The environment ID.

env-xxxxx
Iconstring

The URL of the icon.

http://xxx
Languagestring

The language.

zh
LatestVersionstring

The latest version number.

1.1.17
Namestring

The name of the feature.

metric-agent
Statusstring

The installation status of the agent.

  • Installing: The agent is being installed.
  • Success: The agent is installed.
  • Failed: The agent failed to be installed.
  • UnInstall: The agent is uninstalled or has not been installed.
  • Uninstalling: The agent is being uninstalled.
  • UnInstallFailed: The agent failed to be uninstalled.
Success
Versionstring

The version number.

1.1.17
Managedboolean

Indicates whether the component is fully managed.

FeatureStatusobject

The status of the feature.

FeatureContainersarray<object>

The containers of the feature.

featureContainersobject

Feature container information.

Argsarray

The container parameters.

argsstring

The value of the parameter.

[ "--port=9335", "--yaml=/etc/config/prometheusDisk/prometheus.yaml", "--chartVersion=1.1.17" ]
Imagestring

The container image.

registry-cn-hangzhou-vpc.ack.aliyuncs.com/acs/arms-prometheus-agent:v4.0.0
Namestring

The container name.

arms-prometheus-operator
Namestring

The Kubernetes resource name of the feature.

arms-prometheus-ack-arms-prometheus
Namespacestring

The namespace.

arms-prom
Statusstring

The status of the agent. Valid values:

  • Success: The agent is running.
  • Failed: The agent failed to run.
  • Not Found: The agent is not installed.
Success
SecurityGroupIdstring

The ID of the security group.

sg-bp1c9fcexoalq9po6cp8
VSwitchIdstring

The ID of the vSwitch.

vsw-bp1qt6ict0dbxgv4wer8l
BindResourceIdstring

The ID of the resource.

c013823b55e4b4d6bb6b6f28682bd38a7
Ipsarray

The IP address of the pod.

ipsstring

The IP address.

10.192.213.201

Examples

Sample success responses

JSONformat

{
  "RequestId": "01FF8DD9-A09C-47A1-895A-B6E321BE77B6",
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": {
    "Feature": {
      "Alias": "Prometheus agent.",
      "Config": {
        "key": "{}"
      },
      "Description": "Collect Metric data using the Prometheus collection specification.",
      "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-bp1c9fcexoalq9po6cp8",
      "VSwitchId": "vsw-bp1qt6ict0dbxgv4wer8l",
      "BindResourceId": "c013823b55e4b4d6bb6b6f28682bd38a7",
      "Ips": [
        "10.192.213.201"
      ]
    }
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-23The response structure of the API has changedView Change Details
2024-05-07The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-01-23The response structure of the API has changedView Change Details