全部产品
Search

搜索本产品

    云服务器 ECS：DescribeCloudAssistantSettings - 查询云助手服务配置

    文档中心

    云服务器 ECS：DescribeCloudAssistantSettings - 查询云助手服务配置

    更新时间：Apr 01, 2026

    查询云助手服务配置。

    调试

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

    调试

    授权信息

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

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

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

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

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

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

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

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

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    ecs:DescribeCloudAssistantSettings

    list

    *ServiceSettings

    acs:ecs:{#regionId}:{#accountId}:servicesettings/{#servicesettingId}

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    SettingType

    array

    是

    待查询的服务配置列表。

    string

    否

    待查询的服务配置类型。当前取值范围：

    • SessionManagerDelivery：会话操作记录投递。

    • InvocationDelivery：任务执行记录投递。

    • AgentUpgradeConfig：云助手 Agent 升级配置。

    • SessionManagerConfig: 云助手 SessionManager 配置。

    SessionManagerDelivery
    RegionId

    string

    是

    地域 ID。

    cn-hangzhou

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

    请求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    OssDeliveryConfigs

    object

    OssDeliveryConfig

    array<object>

    OSS 投递配置列表。

    object

    OSS 投递配置信息。

    EncryptionType

    string

    OSS 加密方式，可能值：

    • Inherit：继承 Bucket；

    • OssManaged：OSS 完全托管；

    • KMS：KMS 加密。

    Inherit
    EncryptionAlgorithm

    string

    OSS 加密算法，可能值：

    • AES256

    • SM4

    AES256
    DeliveryType

    string

    投递类型，可能值：

    • SessionManager：会话操作记录。

    • Invocation：任务执行记录。

    SessionManager
    Enabled

    boolean

    是否开启投递到 OSS 功能。

    false
    BucketName

    string

    OSS 存储空间名称。

    example-bucket
    Prefix

    string

    OSS 存储空间目录前缀。

    sessionmanager/audit
    EncryptionKeyId

    string

    加密方式为 KMS 时，用户的主密钥 CMK ID。

    a807****7a70e
    SlsDeliveryConfigs

    object

    SlsDeliveryConfig

    array<object>

    SLS 投递配置列表。

    object

    SLS 投递配置信息。

    DeliveryType

    string

    投递类型，可能值：

    • SessionManager：会话操作记录。

    • Invocation：任务执行记录。

    SessionManager
    LogstoreName

    string

    SLS 日志库名称。

    example-logstore
    Enabled

    boolean

    是否开启投递到 SLS 功能。

    false
    ProjectName

    string

    SLS 项目名称。

    example-project
    AgentUpgradeConfig

    object

    云助手 Agent 升级配置。

    Enabled

    boolean

    是否开启自定义 Agent 升级配置。如查询结果为 false 或空，默认保持每 30 分钟尝试升级一次。

    true
    AllowedUpgradeWindows

    object

    AllowedUpgradeWindow

    array

    允许升级的时间段列表。

    string

    允许升级的时间段列表。

    [ "02:00-03:00", "05:00-06:00" ]
    TimeZone

    string

    允许升级时间段的时区。

    Asia/Shanghai
    BootstrapUpgrade

    boolean

    是否在云助手 Agent 启动时立即检查和进行更新。

    true
    DisableUpgrade

    boolean

    是否禁止云助手 Agent 检查和进行更新。

    true
    ResourceUsageConfig

    object

    云助手资源占用配置。

    CpuLimit

    integer

    云助手 Agent 主进程最大允许的 CPU 占用限制。

    20
    MemoryLimit

    string

    云助手 Agent 主进程最大允许的内存占用限制。

    35MB
    OverloadLimit

    integer

    CPU 或内存资源占用连续超限次数上限，达到上限后云助手 Agent 自动终止运行。

    3
    LogFileCountLimit

    integer

    云助手日志文件的最大保存数量。

    30
    LogSizeLimit

    string

    云助手日志文件的大小限制。

    100MB
    KeepScriptFile

    boolean

    命令执行完成后，是否保留脚本文件到云助手目录。

    false
    SessionManagerConfig

    object

    云助手会话功能配置。

    SessionManagerEnabled

    boolean

    云助手会话功能开关。取值范围：

    • true: 开启；

    • false: 关闭。

    注意事项：

    • 会话功能开启/关闭对全部地域生效。

    true

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "OssDeliveryConfigs": {
    "OssDeliveryConfig": [
      {
        "EncryptionType": "Inherit",
        "EncryptionAlgorithm": "AES256",
        "DeliveryType": "SessionManager",
        "Enabled": false,
        "BucketName": "example-bucket",
        "Prefix": "sessionmanager/audit",
        "EncryptionKeyId": "a807****7a70e"
      }
    ]
  },
  "SlsDeliveryConfigs": {
    "SlsDeliveryConfig": [
      {
        "DeliveryType": "SessionManager",
        "LogstoreName": "example-logstore",
        "Enabled": false,
        "ProjectName": "example-project"
      }
    ]
  },
  "AgentUpgradeConfig": {
    "Enabled": true,
    "AllowedUpgradeWindows": {
      "AllowedUpgradeWindow": [
        "[\n\"02:00-03:00\",\n\"05:00-06:00\"\n]"
      ]
    },
    "TimeZone": "Asia/Shanghai",
    "BootstrapUpgrade": true,
    "DisableUpgrade": true
  },
  "ResourceUsageConfig": {
    "CpuLimit": 20,
    "MemoryLimit": "35MB",
    "OverloadLimit": 3,
    "LogFileCountLimit": 30,
    "LogSizeLimit": "100MB",
    "KeepScriptFile": false
  },
  "SessionManagerConfig": {
    "SessionManagerEnabled": true
  }
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidParameter.SettingType The specified parameter SettingType is not valid. 指定的参数SettingType不合法。
    500 InternalError An error occurred when you dispatched the request. 发送请求时发生错误，请稍后重试。
    404 InvalidRegionId.NotFound The specified parameter RegionId does not exist. 指定的地域ID不存在。

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

    变更历史

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