All Products
Search
Document Center

Managed Service for Prometheus:ListAddons

Last Updated:May 09, 2024

Queries a list of cloud services that are supported in the new integration center.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListAddonsWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
SearchstringNo

A query field can be queried by name or description.

mysql
RegexpbooleanNo

Whether to enable regular matching.

false
AliyunLangstringNo

Language,the default language is Chinese.

zh
CategorystringNo

Category filter.

database

Response parameters

ParameterTypeDescriptionExample
object

response

RequestIdstring

Id of the request

78901766-3806-4E96-8E47-CFEF59E4****
Codeinteger

Status code: 200 indicates success.

200
Messagestring

The returned message.

success
Successboolean

Indicates whether the alert rule was deleted. Valid values:

  • true: The alert rule was deleted.
  • false: The alert rule failed to be deleted.
true
Dataobject []

The returned struct.

Aliasstring

Ailas of the Addon.

MySQL
Categoriesarray

Categories list.

string

Categories value.

cloud
Dashboardsobject []

Dashboard list.

Descriptionstring

Description of the dashboard.

MySQL monitors the market information, monitoring the connection information, usage information and other indicators
Namestring

Name of the dashboard.

mysql-overview
Urlstring

URL of the dashboard.

http://xxxx
Descriptionstring

Description of the Addon.

Monitor database indicators with MySQL Exporter
Environmentsobject []

Environment list.

Dependenciesobject

Dependency list.

Featuresobject

Name of the Feature.

boolean

Support or not.

true
Servicesarray

Service list.

string

Service name.

ResourceCenter
Descriptionstring

Description of environment.

The MySQL service is deployed in a Kubernetes cluster.
Enableboolean

Whether to enable it.

true
Labelstring

Label of the environment.

Container
Namestring

Name of the environment.

CS
Policiesobject

Policies list.

AlertDefaultStatusstring

Default alert status.

default
DefaultInstallboolean

Default install status.

false
TargetAddonNamestring

Target Addon name.

cloud-rds-mysql
Protocolsobject []

Protocol list.

Namestring

Name of the Protocol.

arms
Labelstring

Label of the Protocol.

ARMS
Iconstring

Icon address.

http://xxxxxxx
Descriptionstring

Description of the Protocol.

ARMS
EnableServiceAccountboolean

Whether to enable a service account.

false.
NeedRestartAfterIntegrationboolean

Whether to restart after integration.

false
MetricCheckRuleobject

Metric check rule PromQL.

PromQLarray

PromQL list.

string

PromQL.

scraper_up{scraper=\"ecs\"}==1
Iconstring

Icon address.

http://xxxx
Keywordsarray

Keyword list.

string

Keyword details.

Java
Languagestring

Language.

zh
Namestring

Name of the Addon.

mysql
Onceboolean

Whether to install it only once.

false
Scenestring

Scene of the Addon.

database
Versionstring

Version of the Addon.

0.0.1
Weightstring

Weight of the Addon.

857
LatestReleaseCreateTimestring

Last installation time.

2023-09-22T16:56:29+08:00

Examples

Sample success responses

JSONformat

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Code": 200,
  "Message": "success",
  "Success": true,
  "Data": [
    {
      "Alias": "MySQL",
      "Categories": [
        "cloud"
      ],
      "Dashboards": [
        {
          "Description": "MySQL monitors the market information, monitoring the connection information, usage information and other indicators",
          "Name": "mysql-overview",
          "Url": "http://xxxx"
        }
      ],
      "Description": "Monitor database indicators with MySQL Exporter",
      "Environments": [
        {
          "Dependencies": {
            "Features": {
              "key": true
            },
            "Services": [
              "ResourceCenter"
            ]
          },
          "Description": "The MySQL service is deployed in a Kubernetes cluster.",
          "Enable": true,
          "Label": "Container",
          "Name": "CS",
          "Policies": {
            "AlertDefaultStatus": "default",
            "DefaultInstall": false,
            "TargetAddonName": "cloud-rds-mysql",
            "Protocols": [
              {
                "Name": "arms",
                "Label": "ARMS",
                "Icon": "http://xxxxxxx",
                "Description": "ARMS"
              }
            ],
            "EnableServiceAccount": true,
            "NeedRestartAfterIntegration": false,
            "MetricCheckRule": {
              "PromQL": [
                "scraper_up{scraper=\\\"ecs\\\"}==1"
              ]
            }
          }
        }
      ],
      "Icon": "http://xxxx",
      "Keywords": [
        "Java"
      ],
      "Language": "zh",
      "Name": "mysql",
      "Once": false,
      "Scene": "database",
      "Version": "0.0.1",
      "Weight": "857",
      "LatestReleaseCreateTime": "2023-09-22T16:56:29+08:00"
    }
  ]
}

Error codes

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