文档

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

请求参数

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

阿里云容器服务 Kubernetes 版的 Kubernetes 集群的 ID。

cc7a37ee31aea4ed1a059eff8034b****
RegionIdstring

地域 ID。

cn-hangzhou
Integrationstring

ARMS 支持的软件缩写。可选值(不区分大小写):ASMIoTFlink

asm

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

Integration 的接入状态。

  • true:表示已接入。
  • false:表示未接入。
true
Codeinteger

状态码。200 为成功,其他状态码为异常。

200
Messagestring

返回结果的提示信息。

success

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-29OpenAPI 变更为 deprecated,即将下线看变更集
变更项变更内容
API 弃用说明(deprecated)OpenAPI 变更为 deprecated,即将下线
2023-03-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈