GetIntegrationState - 获取Integration的接入状态

目前该API接口已标记为弃用,推荐使用替代API:ARMS(2019-08-08) - DescribeAddonRelease

来获取Integration的接入状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:GetIntegrationStatenone
*Prometheus
acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}

请求参数

名称类型必填描述示例值
Actionstring

系统规定参数。取值:GetIntegrationState

GetIntegrationState
ClusterIdstring

The ID of the Container Service for Kubernetes (ACK) cluster.

cc7a37ee31aea4ed1a059eff8034b****
RegionIdstring

The region ID.

cn-hangzhou
Integrationstring

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

asm

返回参数

名称类型描述示例值
object

The response schema.

RequestIdstring

The ID of the request.

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

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
Codeinteger

Status code. 200 means success, other status codes are exceptions.

200
Messagestring

The prompt information of the returned result.

success

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-29OpenAPI 变更为 deprecated,即将下线查看变更详情
2023-03-20OpenAPI 返回结构发生变更查看变更详情