全部产品
Search

搜索本产品

    Alibaba Cloud Linux：AuthDiagnosis - 授权诊断

    文档中心

    Alibaba Cloud Linux：AuthDiagnosis - 授权诊断

    更新时间：Sep 11, 2026

    本接口用于授权 SysOM 对本账号下的 ECS 实例进行诊断，只有在调用本接口对特定的ECS进行授权后，才可以调用 InvokeDiagnosis 接口对其发起诊断。

    接口说明

    重要 诊断功能需要在 RAM 用户下创建服务角色，调用本接口会自定检查服务角色是否创建，如果服务角色不存在则会自动创建，这要求调用本接口的 RAM 用户具有 ram:CreateServiceLinkedRole 权限

    调用本接口授权 SysOM 对 ECS 进行诊断有如下注意事项：

    • 一次授权有效期为 7 天，7 天之后授权会失效，需要再次调用本接口进行授权；

    • 调用本接口进行授权时如果 SysOM 服务关联角色（AliyunServiceRoleForSysom）不存在会自动创建，这要求调用本接口的 RAM 用户具有 ram:CreateServiceLinkedRole 权限。

    • 调用本接口对特定实例进行授权，会自动给目标 ecs 实例打上标签 sysom:diagnosis，sysom 只允许对打了这个标签的实例进行诊断。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    sysom:AuthDiagnosis

    none

    *全部资源

    *

    		 无 无

    请求语法

    POST /api/v1/openapi/diagnosis/auth HTTP/1.1

    请求参数

    名称

    类型

    必填

    描述

    示例值
    body

    object

    否

    请求体参数。

    autoCreateRole

    boolean

    否

    自动创建角色

    autoInstallAgent

    boolean

    否

    自动安装 agent

    instances

    array<object>

    是

    授权诊断的机器列表

    object

    否

    i-wz9gdv7qmdhntqmc4rjd
    instance

    string

    否

    实例 ID。

    i-wz9b9vucz1iubsz8sjqo
    region

    string

    否

    地域 ID。

    cn-hangzhou

    返回参数

    名称

    类型

    描述

    示例值

    object

    返回结果

    code

    string

    状态码

    • code == Success 则代表授权成功；

    • 其它状态码代表授权失败，授权失败时查看 message 字段获取详细的错误信息；

    Success
    data

    any

    本接口没有返回数据

    {}
    message

    string

    错误信息

    • 如果 code == Success，则本字段为空；

    • 否则本字段包含请求错误信息。

    SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
    request_id

    string

    请求 RequestId

    35F91AAB-5FDF-5A22-B211-C7C6B00817D0

    示例

    正常返回示例

    JSON格式

    {
  "code": "Success",
  "data": "{}",
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0"
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 SysomOpenAPI.NotSupportedAgentVersion Unsupported sysom agent version. 不支持的 SysOM 客户端版本。

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

    变更历史

    更多信息，参考变更详情。