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

Queries Cloud Assistant service configurations.

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 list of service configurations to query.
	string	No	The type of service configuration to query. Valid values: SessionManagerDelivery: session operation log delivery. InvocationDelivery: task execution log delivery. AgentUpgradeConfig: Cloud Assistant Agent upgrade configuration. SessionManagerConfig: Cloud Assistant SessionManager configuration.	SessionManagerDelivery
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
AgentUpgradeConfig	object	The Cloud Assistant Agent upgrade configuration.
AllowedUpgradeWindows	object
AllowedUpgradeWindow	array	The list of allowed upgrade time windows.
	string	The list of allowed upgrade time windows.	[ "02:00-03:00", "05:00-06:00" ]
BootstrapUpgrade	boolean	Indicates whether the Cloud Assistant Agent checks for and performs updates immediately upon startup.	true
DisableUpgrade	boolean	Indicates whether the Cloud Assistant Agent is prohibited from checking for and performing updates.	true
Enabled	boolean	Indicates whether the custom Agent upgrade configuration is enabled. If the query result is false or empty, the default behavior of attempting an upgrade every 30 minutes is retained.	true
TimeZone	string	The time zone of the allowed upgrade time windows.	Asia/Shanghai
OssDeliveryConfigs	object
OssDeliveryConfig	array<object>	The list of OSS delivery configurations.
	object	The OSS delivery configuration information.
BucketName	string	The name of the OSS bucket.	example-bucket
DeliveryType	string	The delivery type. Valid values: SessionManager: session operation logs. Invocation: task execution logs.	SessionManager
Enabled	boolean	Indicates whether delivery to OSS is enabled.	false
EncryptionAlgorithm	string	The OSS encryption algorithm. Valid values: AES256 SM4	AES256
EncryptionKeyId	string	The customer master key (CMK) ID used when the encryption method is KMS.	a807****7a70e
EncryptionType	string	The OSS encryption method. Valid values: Inherit: Inherited from the bucket. OssManaged: Fully managed by OSS. KMS: KMS encryption.	Inherit
Prefix	string	The directory prefix of the OSS bucket.	sessionmanager/audit
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ResourceUsageConfig	object	The Cloud Assistant resource usage configuration.
CpuLimit	integer	The maximum CPU usage allowed for the Cloud Assistant Agent main process.	20
KeepScriptFile	boolean	Indicates whether the script file is retained in the Cloud Assistant directory after command execution is complete.	false
LogFileCountLimit	integer	The maximum number of Cloud Assistant log files to retain.	30
LogSizeLimit	string	The size limit of Cloud Assistant log files.	100MB
MemoryLimit	string	The maximum memory usage allowed for the Cloud Assistant Agent main process.	35MB
OverloadLimit	integer	The maximum number of consecutive times that CPU or memory resources usage can exceed the limit. After this limit is reached, the Cloud Assistant Agent automatically stops running.	3
SessionManagerConfig	object	The Cloud Assistant session feature configuration.
SessionManagerEnabled	boolean	The toggle for the Cloud Assistant session feature. Valid values: true: Enabled. false: Disabled. Precautions: Enabling or disabling the session feature takes effect in all regions.	true
SlsDeliveryConfigs	object
SlsDeliveryConfig	array<object>	The list of SLS delivery configurations.
	object	The SLS delivery configuration information.
DeliveryType	string	The delivery type. Valid values: SessionManager: session operation logs. Invocation: task execution logs.	SessionManager
Enabled	boolean	Indicates whether delivery to SLS is enabled.	false
LogstoreName	string	The name of the SLS Logstore.	example-logstore
ProjectName	string	The name of the SLS project.	example-project

Examples

Success response

JSON format

{
  "AgentUpgradeConfig": {
    "AllowedUpgradeWindows": {
      "AllowedUpgradeWindow": [
        "[\n\"02:00-03:00\",\n\"05:00-06:00\"\n]"
      ]
    },
    "BootstrapUpgrade": true,
    "DisableUpgrade": true,
    "Enabled": true,
    "TimeZone": "Asia/Shanghai"
  },
  "OssDeliveryConfigs": {
    "OssDeliveryConfig": [
      {
        "BucketName": "example-bucket",
        "DeliveryType": "SessionManager",
        "Enabled": false,
        "EncryptionAlgorithm": "AES256",
        "EncryptionKeyId": "a807****7a70e",
        "EncryptionType": "Inherit",
        "Prefix": "sessionmanager/audit"
      }
    ]
  },
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ResourceUsageConfig": {
    "CpuLimit": 20,
    "KeepScriptFile": false,
    "LogFileCountLimit": 30,
    "LogSizeLimit": "100MB",
    "MemoryLimit": "35MB",
    "OverloadLimit": 3
  },
  "SessionManagerConfig": {
    "SessionManagerEnabled": true
  },
  "SlsDeliveryConfigs": {
    "SlsDeliveryConfig": [
      {
        "DeliveryType": "SessionManager",
        "Enabled": false,
        "LogstoreName": "example-logstore",
        "ProjectName": "example-project"
      }
    ]
  }
}

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.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	The specified RegionId does not exist. Check whether the product is available in this region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.