All Products
Search
Document Center

Application Real-Time Monitoring Service:ListCmsInstances

Last Updated:Mar 22, 2023

Queries the information about the collection of cloud services.

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 keyAssociation operation
arms:ListCmsInstancesList
  • ARMS
    acs:arms:{#regionId}:{#accountId}:prometheus/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
ClusterIdstringYes

The ID of the cluster.

n9p9o9o3se
TypeFilterstringYes

The filter condition. Format: [unk]{"key":"value"}[unk]. You must set the [unk]key[unk] and [unk]value[unk] fields.

direct

Response parameters

ParameterTypeDescriptionExample
object

The struct returned.

RequestIdstring

The ID of the request.

E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1
Dataobject

The struct returned.

EnableTagboolean

Indicates whether to collect the aliyun tags attached to each cloud service.

true
Productsarray

The struct returned.

object

The struct returned.

Descrstring

The description of the cloud service.

-
Instancestring

The name of the instance.

cloudserver
Prodstring

The code of the cloud service.

face
Namestring

The name of the cloud service.

hologres
Idstring

The ID of the instance.

20210
Statestring

The status of the integration. Valid values:

  • true: The integration was enabled.
  • false: The integration was disabled.
true
Timestring

The timestamp when the Grafana dashboard was created.

1647852021000
Typestring

The type of the cloud service.

HOLOGRES
Urlstring

The complete URL of the Grafana dashboard.

https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\u003d9\u0026refresh\u003d60s
Sourcestring

The event source.

arms

Examples

Sample success responses

JSONformat

{
  "RequestId": "E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1",
  "Data": {
    "EnableTag": true,
    "Products": [
      {
        "Descr": "-\n",
        "Instance": "cloudserver",
        "Prod": "face",
        "Name": "hologres",
        "Id": "20210",
        "State": "true",
        "Time": "1647852021000",
        "Type": "HOLOGRES",
        "Url": "https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\\u003d9\\u0026refresh\\u003d60s",
        "Source": "arms"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2022-09-01The input parameters of the API operation change.
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: TypeFilter