ModifyCloudAssistantSettings-阿里云帮助中心

Modifies the Cloud Assistant service configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:ModifyCloudAssistantSettings

update

*ServiceSettings

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
SettingType	string	Yes	The service configuration type. Valid values: SessionManagerDelivery: session operation record delivery InvocationDelivery: task execution record delivery AgentUpgradeConfig: Cloud Assistant Agent upgrade configuration SessionManagerConfig: Cloud Assistant SessionManager configuration	SessionManagerDelivery
OssDeliveryConfig	object	No	The OSS delivery configuration.
Enabled	boolean	No	Specifies whether to enable delivery to OSS. Default value: false.	false
BucketName	string	No	The name of the OSS bucket.	example-bucket
Prefix	string	No	The directory prefix of the OSS bucket. Constraints: The length cannot exceed 254 characters. It cannot start with a forward slash (/) or a backslash (). Note: Pass an empty string ("") to indicate that no directory prefix is required. If a directory prefix was previously set and is no longer needed, pass an empty string ("") to clear it.	sessionmanager/audit
EncryptionType	string	No	The OSS encryption method. Valid values: Inherit: inherit from the bucket OssManaged: fully managed by OSS KMS: KMS encryption	Inherit
EncryptionAlgorithm	string	No	The OSS encryption algorithm. Valid values: AES256 SM4	AES256
EncryptionKeyId	string	No	The ID of the customer master key (CMK) when the encryption method is KMS.	a807****7a70e
SlsDeliveryConfig	object	No	The Simple Log Service (SLS) delivery configuration.
Enabled	boolean	No	Specifies whether to enable delivery to SLS. Default value: false.	false
ProjectName	string	No	The name of the SLS project.	example-project
LogstoreName	string	No	The name of the SLS Logstore.	example-logstore
AgentUpgradeConfig	object	No	The Cloud Assistant Agent upgrade configuration.
Enabled	boolean	No	Specifies whether to enable the custom Agent upgrade configuration. If set to false, the system attempts to upgrade the agent every 30 minutes by default. Default value: false.	true
AllowedUpgradeWindow	array	No	The list of time windows during which upgrades are allowed. The time can be accurate to minutes. The default time zone is UTC. The interval between time windows cannot be less than 1 hour. Format: start time (HH:mm)-end time (HH:mm). Example: [ "02:00-03:00", "05:00-06:00" ] This indicates that upgrades are allowed every day from 02:00 to 03:00 and from 05:00 to 06:00 in the UTC time zone.
	string	No	The list of time windows during which upgrades are allowed. The time can be accurate to minutes. The default time zone is UTC. The interval between time windows cannot be less than 1 hour. Format: start time (HH:mm)-end time (HH:mm). Example: [ "02:00-03:00", "05:00-06:00" ] This indicates that upgrades are allowed every day from 02:00 to 03:00 and from 05:00 to 06:00 in the UTC time zone.	[ "02:00-03:00", "05:00-06:00" ]
TimeZone	string	No	The time zone for the allowed upgrade time windows. The default time zone is UTC. The time zone supports the following two formats: Full name of the time zone: such as Asia/Shanghai (China/Shanghai time) and America/Los_Angeles (US/Los Angeles time). Offset of the time zone relative to Greenwich Mean Time (GMT): such as GMT+8:00 (East 8th zone) and GMT-7:00 (West 7th zone). Leading zeros are not supported for the hour digit.	Asia/Shanghai
BootstrapUpgrade	boolean	No	Specifies whether to immediately check the version and perform updates when the Cloud Assistant Agent starts. Default value: true. This parameter takes effect only when the Cloud Assistant Agent version is not earlier than the following versions: Windows: 2.1.4.1065 Linux: 2.2.4.1065	true
DisableUpgrade	boolean	No	Specifies whether to disable the Cloud Assistant Agent from checking and performing updates. Default value: false. Precautions: You must fully evaluate the security risks and business impacts caused by disabling upgrades or continuing to run an earlier version of the Agent. You are responsible for any risks and impacts that arise. The disable upgrade configuration takes effect at the account level. It applies to all ECS instances under the account and does not support individual exemptions by instance. Therefore, the aforementioned risks cover all instances within the account. This parameter takes effect only when the Cloud Assistant Agent version is not earlier than the following versions: Windows: 2.1.4.1065 Linux: 2.2.4.1065	false
ResourceUsageConfig	object	No	The Cloud Assistant resource usage configuration. This parameter takes effect only when the Cloud Assistant Agent version is not earlier than the following versions: Windows: 2.1.4.1065 Linux: 2.2.4.1065
CpuLimit	integer	No	The maximum allowed CPU usage limit for the main process of the Cloud Assistant Agent. Unit: percentage. Valid values: 10 to 95. Default value: 20.	20
MemoryLimit	string	No	The maximum allowed memory usage limit for the main process of the Cloud Assistant Agent. A unit (B, KB, or MB) must be specified. Default value: 50MB. Minimum value: 35MB. Maximum value: 1024MB.	50MB
OverloadLimit	integer	No	The maximum number of consecutive times that the usage of CPU or memory resources exceeds the limit. After reaching this limit, the Cloud Assistant Agent automatically stops. Default value: 3. Minimum value: 3.	3
LogFileCountLimit	integer	No	The maximum number of Cloud Assistant log files to retain. Default value: 30. Minimum value: 7. Maximum value: 365.	30
LogSizeLimit	string	No	The size limit for a single Cloud Assistant log file. A unit (B, KB, or MB) must be specified. Default value: 100MB. Minimum value: 10MB. Maximum value: 1024MB.	10MB
KeepScriptFile	boolean	No	Specifies whether to retain the script file in the Cloud Assistant directory after command execution is completed. Default value: false.	false
SessionManagerConfig	object	No	The Cloud Assistant session feature configuration.
SessionManagerEnabled	boolean	No	The Cloud Assistant session feature switch. Valid values: true: enabled false: disabled Precautions: Enabling or disabling the session feature takes effect across all regions.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceBusy.SlrCreation	The ServiceLinkedRole is still being created or has not taken effect yet. Please try again later.
400	InvalidParameter.SettingType	The specified parameter SettingType is not valid.	The specified parameter SettingType is illegal.
400	InvalidParameter.OssEncryptionType	The specified parameter OssDeliveryConfig.EncryptionType is not valid.	The specified parameter OssDeliveryConfig.EncryptionType is not valid.
400	InvalidParameter.OssEncryptionAlgorithm	The specified parameter OssDeliveryConfig.EncryptionAlgorithm is not valid.	The specified parameter OssDeliveryConfig.EncryptionAlgorithm is illegal.
400	InvalidParameter.OssEncryptionKeyId	The specified parameter OssDeliveryConfig.EncryptionKeyId is not valid.	The specified parameter OssDeliveryConfig.EncryptionKeyId is illegal.
400	InvalidParameter.OssBucketName	The specified parameter OssDeliveryConfig.BucketName is not valid.	The specified parameter OssDeliveryConfig.BucketName is illegal.
400	InvalidParameter.OssPrefix	The specified parameter OssDeliveryConfig.Prefix is not valid.	The specified parameter OssDeliveryConfig.Prefix is invalid.
400	InvalidOssBucketName.InOtherRegion	The specified parameter OssDeliveryConfig.BucketName is in another region.	The OSS bucket corresponding to the specified parameter OssDeliveryConfig.BucketName is in another region.
400	InvalidParameter.SlsProjectName	The specified parameter SlsDeliveryConfig.ProjectName is not valid.	The specified parameter SlsDeliveryConfig.ProjectName is invalid.
400	InvalidParameter.SlsLogstoreName	The specified parameter SlsDeliveryConfig.LogstoreName is not valid.	The specified parameter SlsDeliveryConfig.LogstoreName is invalid.
400	InvalidParameter.AllowedUpgradeWindow	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is not valid.	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is illegal.
400	InvalidAllowedUpgradeWindow.DurationTooShort	The duration of the specified parameter AgentUpgradeConfig.AllowedUpgradeWindow cannot be less than one hour.	The interval for the AllowedUpgradeWindow parameter cannot be shorter than 30 minutes.
400	InvalidParameter.TimeZone	The specified parameter AgentUpgradeConfig.TimeZone is not valid.	The specified AgentUpgradeConfig.TimeZone parameter is invalid.
400	InvalidAllowedUpgradeWindow.Required	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is required.	When you enable the custom agent upgrade configuration parameter, AgentUpgradeConfig.AllowedUpgradeWindow is required.
400	InvalidParameter.CpuLimit	The specified parameter CpuLimit is not valid.
400	InvalidParameter.MemoryLimit	The specified parameter MemoryLimit is not valid.
400	InvalidParameter.OverloadLimit	The specified parameter OverloadLimit is not valid.
400	InvalidParameter.LogFileCountLimit	The specified parameter LogFileCountLimit is not valid.
400	InvalidParameter.LogSizeLimit	The specified parameter LogSizeLimit is not valid.
500	InternalError	An error occurred when you dispatched the request.	An error occurred while sending the request, please try again later.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InvalidOssBucketName.AccessDenied	The error message returned by the OSS API is: %s
403	CreateServiceLinkedRole.NoPermission	You do not have permission to create ServiceLinkedRole.	You do not have permission to create a service-linked role.
403	InvalidOperation.OssEncryptionUnsupported	The configuration of OSS Encryption is not supported.	The current service does not support setting the OSS encryption mode.
403	InvalidAllowedUpgradeWindow.CountLimitExceeded	The count of the parameter AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5.	The number of parameters AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5.
403	InvalidOperation.SessionManagerDeliveryUnsupported	The delivery configuration of Session Manager is not supported.	Enabling Session Manager delivery configurations is not supported.
403	InvalidDisableUpgrade.Conflict	The parameter DisableUpgrade cannot be specified with parameter BootstrapUpgrade.
404	InvalidSlsProjectName.NotFound	The specified parameter SlsDeliveryConfig.ProjectName does not exist.	The specified SLS project does not exist.
404	InvalidSlsLogstoreName.NotFound	The specified parameter SlsDeliveryConfig.LogstoreName does not exist.	The specified SLS Logstore does not exist.
404	InvalidOssBucketName.NotFound	The specified parameter OssDeliveryConfig.BucketName does not exist.	The specified OSS bucket does not exist.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	The specified RegionId does not exist. Check whether the service is available in the region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.