帮助文档 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
帮助文档 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 云服务器 ECS
  4. 开发参考
  5. API参考(ECS)
  6. API目录
  7. 云助手
  8. DescribeCloudAssistantSettings - 查询云助手服务配置

DescribeCloudAssistantSettings - 查询云助手服务配置

  • 云助手
  • 发布于 2025-04-01
  • 0 次阅读
文档编辑
文档编辑

查询云助手服务配置。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
SettingTypearray是

待查询的服务配置列表。

string是

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

  • SessionManagerDelivery:会话操作记录投递。
  • InvocationDelivery:任务执行记录投递。
  • AgentUpgradeConfig:云助手 Agent 升级配置。
SessionManagerDelivery
RegionIdstring是

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OssDeliveryConfigsarray<object>

OSS 投递配置列表。

OssDeliveryConfigobject

OSS 投递配置信息。

EncryptionTypestring

OSS 加密方式,可能值:

  • Inherit:继承 Bucket;
  • OssManaged:OSS 完全托管;
  • KMS:KMS 加密。
Inherit
EncryptionAlgorithmstring

OSS 加密算法,可能值:

  • AES256
  • SM4
AES256
DeliveryTypestring

投递类型,可能值:

  • SessionManager:会话操作记录。
  • Invocation:任务执行记录。
SessionManager
Enabledboolean

是否开启投递到 OSS 功能。

false
BucketNamestring

OSS 存储空间名称。

example-bucket
Prefixstring

OSS 存储空间目录前缀。

sessionmanager/audit
EncryptionKeyIdstring

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

a807****7a70e
SlsDeliveryConfigsarray<object>

SLS 投递配置列表。

SlsDeliveryConfigobject

SLS 投递配置信息。

DeliveryTypestring

投递类型,可能值:

  • SessionManager:会话操作记录。
  • Invocation:任务执行记录。
SessionManager
LogstoreNamestring

SLS 日志库名称。

example-logstore
Enabledboolean

是否开启投递到 SLS 功能。

false
ProjectNamestring

SLS 项目名称。

example-project
AgentUpgradeConfigobject

云助手 Agent 升级配置。

Enabledboolean

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

true
AllowedUpgradeWindowsarray

允许升级的时间段列表。

AllowedUpgradeWindowstring

允许升级的时间段列表。

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

允许升级时间段的时区。

Asia/Shanghai

示例

正常返回示例

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"
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.SettingTypeThe specified parameter SettingType is not valid.指定的参数SettingType不合法。
404InvalidRegionId.NotFoundThe specified parameter RegionId does not exist.指定的地域ID不存在。
500InternalErrorAn error occurred when you dispatched the request.发送请求时发生错误,请稍后重试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
相关文章

CreateActivation - 创建一个激活码 2025-04-01 11:57

该接口用于创建一个激活码,该激活码用于将非阿里云服务器注册为阿里云托管实例。

CreateCommand - 创建云助手命令 2025-04-01 11:57

新建一条Shell、PowerShell或者Bat脚本类型的云助手命令。

DeleteActivation - 删除一个未被使用的激活码 2025-04-01 11:57

调用DeleteActivation删除一个未被使用的激活码。

DeleteCommand - 删除一条云助手命令 2025-04-01 11:57

调用DeleteCommand接口,并指定参数RegionId、CommandId删除一条云助手命令。它无法删除正在执行中的命令。

DeregisterManagedInstance - 注销托管实例 2025-04-01 11:57

调用DeregisterManagedInstance注销一个托管实例。注销后您将无法再使用云助手向实例发送命令或文件。

DescribeActivations - 查询激活码的使用情况 2025-04-01 11:57

调用DescribeActivations查询已创建的激活码以及激活码的使用情况。

目录
Copyright © 2025 your company All Rights Reserved. Powered by 博智数字服务平台.
闽ICP备08105208号-1