All Products
Search
Document Center

Application Real-Time Monitoring Service:GetIntegrationState

Last Updated:Apr 27, 2023

Queries the integration state of the dashboards and collection rules of Application Real-Time Monitoring Service (ARMS) Prometheus.

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:GetIntegrationStateRead
  • ARMS
    acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The abbreviation of the software that is supported by Application Real-Time Monitoring Service (ARMS). Valid values (case-insensitive): ASM, IoT, and Flink.

cc7a37ee31aea4ed1a059eff8034b****
RegionIdstringYes

The ID of the request.

cn-hangzhou
IntegrationstringYes

The integration state of Prometheus dashboards and collection rules. Valid values:

  • true: Prometheus dashboards and collection rules are integrated.
  • false: Prometheus dashboards and collection rules are not integrated.
asm

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

auditing

1A9C645C-C83F-4C9D-8CCB-29BEC9E1****
Stateboolean

Queries the integration state of Prometheus dashboards and collection rules for a Container Service for Kubernetes (ACK) cluster.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "1A9C645C-C83F-4C9D-8CCB-29BEC9E1****",
  "State": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-03-20The response structure of the API operation changes.
Change itemChange content
Output ParametersThe response structure of the API operation changes.