All Products
Search
Document Center

Elastic Compute Service:DescribeCloudAssistantSettings

Last Updated:Nov 14, 2024

Queries the configurations of Cloud Assistant.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DescribeCloudAssistantSettingslist
*ServiceSettings
acs:ecs:{#regionId}:{#accountId}:servicesettings/{#servicesettingId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SettingTypearrayYes

The Cloud Assistant configurations.

stringYes

The type of Cloud Assistant configurations. Valid values:

  • SessionManagerDelivery: the Session Record Delivery configurations.
  • InvocationDelivery: the Operation Content and Result Delivery configurations.
  • AgentUpgradeConfig: the Cloud Assistant Agent Upgrade configurations.
SessionManagerDelivery
RegionIdstringYes

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OssDeliveryConfigsarray<object>

The configurations for delivering items to Object Storage Service (OSS).

OssDeliveryConfigobject
EncryptionTypestring

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 with Key Management Service (SSE-KMS).
Inherit
EncryptionAlgorithmstring

The OSS encryption algorithm. Valid values:

  • AES256
  • SM4
AES256
DeliveryTypestring

The type of items to be delivered. Valid values:

  • SessionManager: session records.
  • Invocation: task execution records.
SessionManager
Enabledboolean

Indicates whether to deliver the specified items to OSS.

false
BucketNamestring

The name of the OSS bucket.

example-bucket
Prefixstring

The prefix of the OSS bucket directory.

sessionmanager/audit
EncryptionKeyIdstring

The ID of the customer master key (CMK) when EncryptionType is set to KMS.

a807****7a70e
SlsDeliveryConfigsarray<object>

The configurations for delivering items to Simple Log Service.

SlsDeliveryConfigobject
DeliveryTypestring

The type of items to be delivered. Valid values:

  • SessionManager: session records.
  • Invocation: task execution records.
SessionManager
LogstoreNamestring

The name of the Logstore.

example-logstore
Enabledboolean

Indicates whether to deliver the specified items to Simple Log Service.

false
ProjectNamestring

The name of the Simple Log Service project.

example-project
AgentUpgradeConfigobject

The configurations for upgrading Cloud Assistant Agent.

Enabledboolean

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
AllowedUpgradeWindowsarray

The time windows during which Cloud Assistant Agent can be upgraded.

AllowedUpgradeWindowstring

The time windows during which Cloud Assistant Agent can be upgraded.

[ "02:00-03:00", "05:00-06:00" ]
TimeZonestring

The time zone of the time windows.

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 codeError codeError messageDescription
400InvalidParameter.SettingTypeThe specified parameter SettingType is not valid.The specified parameter SettingType is illegal.
404InvalidRegionId.NotFoundThe specified parameter RegionId does not exist.-
500InternalErrorAn 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.