Use DescribeCloudAssistantSettings to query Cloud Assistant configurations - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Overview of 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:DescribeCloudAssistantSettings

list

*ServiceSettings

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

None

Request parameters

Parameter	Type	Required	Description	Example
SettingType	array	Yes	The types of service configurations to query.
	string	No	A type of service configuration. Valid values: SessionManagerDelivery: Controls the delivery of session operation records. InvocationDelivery: Controls the delivery of command execution records. AgentUpgradeConfig: Controls upgrades for the Cloud Assistant Agent. SessionManagerConfig: Controls settings for Cloud Assistant SessionManager.	SessionManagerDelivery
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OssDeliveryConfigs	object
OssDeliveryConfig	array<object>	A list of OSS delivery configurations.
	object	An OSS delivery configuration.
EncryptionType	string	The encryption type for the OSS delivery. Valid values: `Inherit`: Inherits the encryption settings of the bucket. `OssManaged`: Uses server-side encryption with OSS-managed keys. `KMS`: Uses Key Management Service (KMS) encryption.	Inherit
EncryptionAlgorithm	string	The encryption algorithm for the OSS delivery. Valid values: `AES256` `SM4`	AES256
DeliveryType	string	The delivery type. Valid values: `SessionManager`: Records of operations in Session Manager. `Invocation`: Records of command invocations.	SessionManager
Enabled	boolean	Indicates whether delivery to OSS is enabled.	false
BucketName	string	The name of the OSS bucket.	example-bucket
Prefix	string	The directory prefix in the OSS bucket.	sessionmanager/audit
EncryptionKeyId	string	The ID of the Customer Master Key (CMK) when `EncryptionType` is set to `KMS`.	a807****7a70e
SlsDeliveryConfigs	object
SlsDeliveryConfig	array<object>	A list of SLS delivery configurations.
	object	The SLS delivery configuration.
DeliveryType	string	The delivery type. Valid values: `SessionManager`: Records of operations in Session Manager. `Invocation`: Records of command invocations.	SessionManager
LogstoreName	string	The name of the SLS Logstore.	example-logstore
Enabled	boolean	Indicates whether delivery to SLS is enabled.	false
ProjectName	string	The name of the SLS Project.	example-project
AgentUpgradeConfig	object	The Cloud Assistant agent upgrade configuration.
Enabled	boolean	Indicates whether custom agent upgrade settings are enabled. If this parameter is `false` or not specified, the agent attempts to upgrade every 30 minutes by default.	true
AllowedUpgradeWindows	object
AllowedUpgradeWindow	array	The allowed upgrade time windows.
	string	An upgrade time window.	[ "02:00-03:00", "05:00-06:00" ]
TimeZone	string	The time zone for the allowed upgrade time windows.	Asia/Shanghai
BootstrapUpgrade	boolean	Indicates whether the Cloud Assistant agent checks for and performs an upgrade upon startup.	true
DisableUpgrade	boolean	Indicates whether to disable automatic upgrades for the Cloud Assistant agent.	true
ResourceUsageConfig	object	The Cloud Assistant resource usage configuration.
CpuLimit	integer	The maximum CPU usage limit for the main Cloud Assistant agent process.	20
MemoryLimit	string	The maximum memory usage limit for the main Cloud Assistant agent process.	35MB
OverloadLimit	integer	The maximum number of consecutive times that CPU or memory usage can exceed the specified limits. If this number is reached, the Cloud Assistant agent stops.	3
LogFileCountLimit	integer	The maximum number of Cloud Assistant log files to retain.	30
LogSizeLimit	string	The size limit for each Cloud Assistant log file.	100MB
KeepScriptFile	boolean	Indicates whether to keep the script file in the Cloud Assistant directory after a command finishes execution.	false
SessionManagerConfig	object	The Cloud Assistant Session Manager configuration.
SessionManagerEnabled	boolean	Indicates whether Session Manager is enabled. Valid values: `true`: Enabled. `false`: Disabled. Note: This setting takes effect across all regions.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.SettingType	The specified parameter SettingType is not valid.	The specified parameter SettingType is illegal.
500	InternalError	An error occurred when you dispatched the request.	An error occurred while sending the request, please try again later.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.