修改云助手服务配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:ModifyCloudAssistantSettings | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
SettingType | string | 是 | 服务配置类型。当前取值范围:
| SessionManagerDelivery |
OssDeliveryConfig | object | 否 | OSS 投递配置信息。 | |
Enabled | boolean | 否 | 是否开启投递到 OSS 功能。默认值:false。 | false |
BucketName | string | 否 | OSS 存储空间名称。 | example-bucket |
Prefix | string | 否 | OSS 存储空间目录前缀。约束如下:
注:传入""表示不需要目录前缀;若之前设置过,而当前不再需要目录前缀可传入""清空。 | sessionmanager/audit |
EncryptionType | string | 否 | OSS 加密方式,可选值:
| Inherit |
EncryptionAlgorithm | string | 否 | OSS 加密算法,可选值:
| AES256 |
EncryptionKeyId | string | 否 | 加密方式为 KMS 时,用户的主密钥 CMK ID。 | a807****7a70e |
SlsDeliveryConfig | object | 否 | SLS 投递配置信息。 | |
Enabled | boolean | 否 | 是否开启投递到 SLS 功能。 默认值:false | false |
ProjectName | string | 否 | SLS 项目名称。 | example-project |
LogstoreName | string | 否 | SLS 日志库名称。 | example-logstore |
AgentUpgradeConfig | object | 否 | 云助手 Agent 升级配置。 | |
Enabled | boolean | 否 | 是否开启自定义 Agent 升级配置。如设置为 false,默认保持每 30 分钟尝试升级一次。 默认值:false。 | true |
AllowedUpgradeWindow | array | 否 | 允许升级的时间段列表,可精确到分,默认为 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" ] | |
TimeZone | string | 否 | 允许升级时间段的时区。默认为 UTC 时区。 时区支持以下两种形式:
| Asia/Shanghai |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter.SettingType | The specified parameter SettingType is not valid. | 指定的参数SettingType不合法。 |
400 | InvalidParameter.OssEncryptionType | The specified parameter OssDeliveryConfig.EncryptionType is not valid. | 指定的参数OssDeliveryConfig.EncryptionType不合法。 |
400 | InvalidParameter.OssEncryptionAlgorithm | The specified parameter OssDeliveryConfig.EncryptionAlgorithm is not valid. | 指定的参数OssDeliveryConfig.EncryptionAlgorithm 不合法。 |
400 | InvalidParameter.OssEncryptionKeyId | The specified parameter OssDeliveryConfig.EncryptionKeyId is not valid. | 指定的参数OssDeliveryConfig.EncryptionKeyId不合法。 |
400 | InvalidParameter.OssBucketName | The specified parameter OssDeliveryConfig.BucketName is not valid. | 指定的参数OssDeliveryConfig.BucketName不合法。 |
400 | InvalidParameter.OssPrefix | The specified parameter OssDeliveryConfig.Prefix is not valid. | 指定的参数OssDeliveryConfig.Prefix不合法。 |
400 | InvalidOssBucketName.InOtherRegion | The specified parameter OssDeliveryConfig.BucketName is in another region. | 指定的参数OssDeliveryConfig.BucketName对应的OSS存储空间在其他地域。 |
400 | InvalidParameter.SlsProjectName | The specified parameter SlsDeliveryConfig.ProjectName is not valid. | 指定的参数SlsDeliveryConfig.ProjectName不合法。 |
400 | InvalidParameter.SlsLogstoreName | The specified parameter SlsDeliveryConfig.LogstoreName is not valid. | 指定的参数SlsDeliveryConfig.LogstoreName不合法。 |
400 | InvalidParameter.AllowedUpgradeWindow | The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is not valid. | 指定的参数AgentUpgradeConfig.AllowedUpgradeWindow不合法。 |
400 | InvalidAllowedUpgradeWindow.DurationTooShort | The duration of the specified parameter AgentUpgradeConfig.AllowedUpgradeWindow cannot be less than one hour. | 参数AllowedUpgradeWindow的间隔不能短于1小时。 |
400 | InvalidParameter.TimeZone | The specified parameter AgentUpgradeConfig.TimeZone is not valid. | 指定的参数AgentUpgradeConfig.TimeZone不合法。 |
400 | InvalidAllowedUpgradeWindow.Required | The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is required. | 当您开启自定义Agent升级配置参数时,AgentUpgradeConfig.AllowedUpgradeWindow是必填的。 |
403 | CreateServiceLinkedRole.NoPermission | You do not have permission to create ServiceLinkedRole. | 您没有创建服务关联角色的权限。 |
403 | InvalidOperation.OssEncryptionUnsupported | The configuration of OSS Encryption is not supported. | 当前服务不支持设置OSS加密方式。 |
403 | InvalidAllowedUpgradeWindow.CountLimitExceeded | The count of the parameter AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5. | 参数 AgentUpgradeConfig.AllowedUpgradeWindow的数量超过了5的限制。 |
404 | InvalidSlsProjectName.NotFound | The specified parameter SlsDeliveryConfig.ProjectName does not exist. | 指定的SLS项目不存在。 |
404 | InvalidSlsLogstoreName.NotFound | The specified parameter SlsDeliveryConfig.LogstoreName does not exist. | 指定的SLS日志库不存在。 |
404 | InvalidOssBucketName.NotFound | The specified parameter OssDeliveryConfig.BucketName does not exist. | 指定的OSS存储空间不存在。 |
404 | InvalidRegionId.NotFound | The specified parameter RegionId does not exist. | 指定的地域ID不存在。 |
500 | InternalError | An error occurred when you dispatched the request. | 发送请求时发生错误,请稍后重试。 |
访问错误中心查看更多错误码。