GetIntegrationState - Managed Service for Prometheus - Alibaba Cloud Documentation Center

This API is deprecated. You are advised to use ARMS(2019-08-08) - DescribeAddonRelease.

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

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
arms:GetIntegrationState	none	Prometheus acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the Container Service for Kubernetes (ACK) cluster.	cc7a37ee31aea4ed1a059eff8034b****
RegionId	string	Yes	The ID of the region.	cn-hangzhou
Integration	string	Yes	The abbreviation of the software that is supported by ARMS. Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.	asm

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	1A9C645C-C83F-4C9D-8CCB-29BEC9E1****
State	boolean	The integration state of Prometheus dashboards and collection rules. Valid values: `true`: The Prometheus dashboards and collection rules that monitor the software are integrated. `false`: The Prometheus dashboards and collection rules that monitor the software are not integrated.	true
Code	integer	Status code. 200 means success, other status codes are exceptions.	200
Message	string	The prompt information of the returned result.	success

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-01-29	The API operation is deprecated	View Change Details
2023-03-20	The response structure of the API has changed	View Change Details