DescribeCloudAssistantSettings - Elastic Compute Service

Queries the configurations of Cloud Assistant features.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SettingType	array	Yes	The Cloud Assistant features.
	string	Yes	The Cloud Assistant feature. Valid values: SessionManagerDelivery: the Session Record Delivery feature InvocationDelivery: the Operation Content and Result Delivery feature AgentUpgradeConfig: the Upgrade Cloud Assistant Agent feature	SessionManagerDelivery
RegionId	string	Yes	The region ID.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OssDeliveryConfigs	object []	The configurations for delivering items to Object Storage Service (OSS).
EncryptionType	string	The OSS encryption method. Valid values: Inherit: the encryption method used by the specified bucket. OssManaged: server-side encryption by using OSS-managed keys (SSE-OSS). KMS: server-side encryption by using Key Management Service managed keys (SSE-KMS).	Inherit
EncryptionAlgorithm	string	The OSS encryption algorithm. Valid values: AES256 SM4	AES256
DeliveryType	string	The type of items to be delivered. Valid values: SessionManager: session records Invocation: task execution records	SessionManager
Enabled	boolean	Indicates whether to deliver the specified items to OSS.	false
BucketName	string	The name of the OSS bucket.	example-bucket
Prefix	string	The prefix of the OSS bucket directory.	sessionmanager/audit
EncryptionKeyId	string	The ID of the customer master key (CMK) when EncryptionType is KMS.	a807****7a70e
SlsDeliveryConfigs	object []	The configurations for delivering items to Simple Log Service.
DeliveryType	string	The type of items to be delivered. Valid values: SessionManager: session records Invocation: task execution records	SessionManager
LogstoreName	string	The name of the Logstore.	example-logstore
Enabled	boolean	Indicates whether to deliver the specified items to Simple Log Service.	false
ProjectName	string	The name of the Simple Log Service project.	example-project
AgentUpgradeConfig	object	The configurations for upgrading Cloud Assistant Agent.
Enabled	boolean	Indicates whether custom upgrade is enabled for Cloud Assistant Agent. If the value is false or empty, an upgrade attempt is performed for Cloud Assistant Agent every 30 minutes.	true
AllowedUpgradeWindows	array	The time windows during which Cloud Assistant Agent can be upgraded.
	string	The time window during which Cloud Assistant Agent can be upgraded.	[ "02:00-03:00", "05:00-06:00" ]
TimeZone	string	The time zone of the time window.	Asia/Shanghai

Examples

Sample success responses

JSONformat

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

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.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	-
500	InternalError	An error occurred when you dispatched the request.	An error occurred while sending the request, please try again later.

For a list of error codes, visit the Service error codes.