All Products
Search

This Product

    Managed Service for Prometheus:ListAddonReleases

    Document Center

    Managed Service for Prometheus:ListAddonReleases

    Last Updated:May 09, 2024

    Queries the add-ons installed in an environment.

    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:ListAddonReleasesWrite
    • Environment
      acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    EnvironmentIdstringYes

    Environment instance ID.

    		env-xxx
    AddonNamestringNo

    Name of Addon.

    		mysql
    RegionIdstringNo

    The region ID.

    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object

    response

    RequestIdstring

    Id of the request

    		E9C9DA3D-10FE-472E-9EEF-2D0A3E41****
    Codeinteger

    Status code: 200 indicates success.

    		200
    Successboolean

    Indicates whether the request was successful.

    • true: The request was successful.
    • false: The request failed.
    		true
    Messagestring

    The returned message.

    		success
    Dataobject

    The returned struct.

    Releasesobject []

    Release list.

    AddonNamestring

    Name of Addon.

    		mysql
    AlertRuleCountlong

    Number of alarm groups.

    		1
    Conditionsobject []

    Condition list.

    FirstTransitionTimestring

    First transition time.

    		2018-01-31T14:32:19Z
    LastTransitionTimestring

    Last transition time.

    		2018-01-31T14:32:19Z
    Messagestring

    Details.

    		xxxx
    Reasonstring

    Reason of failure.

    		xxxx
    Statusstring

    Condition status.

    		True
    Typestring

    Condition type.

    		Loaded
    CreateTimestring

    Created time.

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

    Number of dashboard.

    		1
    ExporterCountlong

    Number of Exporter.

    		2
    HaveConfigboolean

    Whether there is configuration.

    		true
    InstallUserIdstring

    User ID of the installation.

    		1268790592387
    Languagestring

    Language.

    		zh
    ReleaseIdstring

    Release ID.

    		be29c093-3fd6-4fb6-9430-797030cc183a
    ReleaseNamestring

    Name of Release.

    		mysql-1695372983039
    Scenestring

    Scene.

    		database
    Statusstring

    Status of Release.

    		0
    UpdateTimestring

    Update time.

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

    User ID.

    		111
    Versionstring

    Version of Addon.

    		0.0.1
    EnvironmentIdstring

    Environment instance ID.

    		env-xxxx
    RegionIdstring

    The ID of the region.

    		cn-heyuan
    Totallong

    The total number of entries returned.

    		12

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "E9C9DA3D-10FE-472E-9EEF-2D0A3E41****",
  "Code": 200,
  "Success": true,
  "Message": "success",
  "Data": {
    "Releases": [
      {
        "AddonName": "mysql",
        "AlertRuleCount": 1,
        "Conditions": [
          {
            "FirstTransitionTime": "2018-01-31T14:32:19Z",
            "LastTransitionTime": "2018-01-31T14:32:19Z",
            "Message": "xxxx",
            "Reason": "xxxx",
            "Status": "True",
            "Type": "Loaded"
          }
        ],
        "CreateTime": "2023-09-22T16:56:29+08:00",
        "DashboardCount": 1,
        "ExporterCount": 2,
        "HaveConfig": true,
        "InstallUserId": "1268790592387",
        "Language": "zh",
        "ReleaseId": "be29c093-3fd6-4fb6-9430-797030cc183a",
        "ReleaseName": "mysql-1695372983039",
        "Scene": "database",
        "Status": "0",
        "UpdateTime": "2023-09-22T16:56:29+08:00",
        "UserId": "111",
        "Version": "0.0.1",
        "EnvironmentId": "env-xxxx",
        "RegionId": "cn-heyuan"
      }
    ],
    "Total": 12
  }
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-01-23The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.