备案控制台
文档
产品文档
输入文档关键字查找
首页 云服务器 ECS 开发参考 API参考（ECS） API目录 云助手 ModifyCloudAssistantSettings - 修改云助手服务配置

ModifyCloudAssistantSettings - 修改云助手服务配置

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

修改云助手服务配置。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

地域 ID。

cn-hangzhou
SettingTypestring是

服务配置类型。当前取值范围：

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

OSS 投递配置信息。

Enabledboolean否

是否开启投递到 OSS 功能。默认值：false。

false
BucketNamestring否

OSS 存储空间名称。

example-bucket
Prefixstring否

OSS 存储空间目录前缀。约束如下：

  • 长度不得超过 254 个字符。
  • 不能以正斜线（/）或者反斜线（\）开头。

注：传入""表示不需要目录前缀；若之前设置过，而当前不再需要目录前缀可传入""清空。

sessionmanager/audit
EncryptionTypestring否

OSS 加密方式，可选值：

  • Inherit：继承 Bucket；
  • OssManaged：OSS 完全托管；
  • KMS：KMS 加密。
Inherit
EncryptionAlgorithmstring否

OSS 加密算法，可选值：

  • AES256
  • SM4
AES256
EncryptionKeyIdstring否

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

a807****7a70e
SlsDeliveryConfigobject否

SLS 投递配置信息。

Enabledboolean否

是否开启投递到 SLS 功能。 默认值：false

false
ProjectNamestring否

SLS 项目名称。

example-project
LogstoreNamestring否

SLS 日志库名称。

example-logstore
AgentUpgradeConfigobject否

云助手 Agent 升级配置。

Enabledboolean否

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

默认值：false。

true
AllowedUpgradeWindowarray否

允许升级的时间段列表，可精确到分，默认为 UTC 时区。

各时间段的间隔不能小于 1 小时。

格式：开始时间(HH:mm)-结束时间(HH:mm)。

如[ "02:00-03:00", "05:00-06:00" ] 代表在 UTC 时区的每天 2 点-3 点、5 点-6 点允许升级。

string否

允许升级的时间段列表，可精确到分，默认为 UTC 时区。

各时间段的间隔不能小于 1 小时。

格式：开始时间(HH:mm)-结束时间(HH:mm)。

如[ "02:00-03:00", "05:00-06:00" ] 代表在 UTC 时区的每天 2 点-3 点、5 点-6 点允许升级。

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

允许升级时间段的时区。默认为 UTC 时区。 时区支持以下两种形式：

  • 时区全称： 如 Asia/Shanghai（中国/上海时间）、America/Los_Angeles（美国/洛杉矶时间）等。
  • 时区相对于格林威治时间的偏移量： 如 GMT+8:00（东八区）、GMT-7:00（西七区）等。小时位不支持添加前导零。
Asia/Shanghai

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.SettingTypeThe specified parameter SettingType is not valid.指定的参数SettingType不合法。
400InvalidParameter.OssEncryptionTypeThe specified parameter OssDeliveryConfig.EncryptionType is not valid.指定的参数OssDeliveryConfig.EncryptionType不合法。
400InvalidParameter.OssEncryptionAlgorithmThe specified parameter OssDeliveryConfig.EncryptionAlgorithm is not valid.指定的参数OssDeliveryConfig.EncryptionAlgorithm 不合法。
400InvalidParameter.OssEncryptionKeyIdThe specified parameter OssDeliveryConfig.EncryptionKeyId is not valid.指定的参数OssDeliveryConfig.EncryptionKeyId不合法。
400InvalidParameter.OssBucketNameThe specified parameter OssDeliveryConfig.BucketName is not valid.指定的参数OssDeliveryConfig.BucketName不合法。
400InvalidParameter.OssPrefixThe specified parameter OssDeliveryConfig.Prefix is not valid.指定的参数OssDeliveryConfig.Prefix不合法。
400InvalidOssBucketName.InOtherRegionThe specified parameter OssDeliveryConfig.BucketName is in another region.指定的参数OssDeliveryConfig.BucketName对应的OSS存储空间在其他地域。
400InvalidParameter.SlsProjectNameThe specified parameter SlsDeliveryConfig.ProjectName is not valid.指定的参数SlsDeliveryConfig.ProjectName不合法。
400InvalidParameter.SlsLogstoreNameThe specified parameter SlsDeliveryConfig.LogstoreName is not valid.指定的参数SlsDeliveryConfig.LogstoreName不合法。
400InvalidParameter.AllowedUpgradeWindowThe specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is not valid.指定的参数AgentUpgradeConfig.AllowedUpgradeWindow不合法。
400InvalidAllowedUpgradeWindow.DurationTooShortThe duration of the specified parameter AgentUpgradeConfig.AllowedUpgradeWindow cannot be less than one hour.参数AllowedUpgradeWindow的间隔不能短于1小时。
400InvalidParameter.TimeZoneThe specified parameter AgentUpgradeConfig.TimeZone is not valid.指定的参数AgentUpgradeConfig.TimeZone不合法。
400InvalidAllowedUpgradeWindow.RequiredThe specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is required.当您开启自定义Agent升级配置参数时，AgentUpgradeConfig.AllowedUpgradeWindow是必填的。
403CreateServiceLinkedRole.NoPermissionYou do not have permission to create ServiceLinkedRole.您没有创建服务关联角色的权限。
403InvalidOperation.OssEncryptionUnsupportedThe configuration of OSS Encryption is not supported.当前服务不支持设置OSS加密方式。
403InvalidAllowedUpgradeWindow.CountLimitExceededThe count of the parameter AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5.参数 AgentUpgradeConfig.AllowedUpgradeWindow的数量超过了5的限制。
404InvalidSlsProjectName.NotFoundThe specified parameter SlsDeliveryConfig.ProjectName does not exist.指定的SLS项目不存在。
404InvalidSlsLogstoreName.NotFoundThe specified parameter SlsDeliveryConfig.LogstoreName does not exist.指定的SLS日志库不存在。
404InvalidOssBucketName.NotFoundThe specified parameter OssDeliveryConfig.BucketName does not exist.指定的OSS存储空间不存在。
404InvalidRegionId.NotFoundThe specified parameter RegionId does not exist.指定的地域ID不存在。
500InternalErrorAn error occurred when you dispatched the request.发送请求时发生错误，请稍后重试。

访问错误中心查看更多错误码。
文档推荐
  • 本页导读 （1）
文档反馈