DescribeCloudAssistantSettings - - Alibaba Cloud Dokümantasyon Merkezi

Cloud Assistant hizmet yapılandırmalarını sorgular.

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	Sorgulanacak hizmet yapılandırmalarının listesi.
	string	No	Sorgulanacak hizmet yapılandırması türü. Geçerli değerler: SessionManagerDelivery: Oturum işlem günlüğü teslimi. InvocationDelivery: Görev yürütme günlüğü teslimi. AgentUpgradeConfig: Cloud Assistant Agent yükseltme yapılandırması. SessionManagerConfig: Cloud Assistant SessionManager yapılandırması.	SessionManagerDelivery
RegionId	string	Yes	Bölge kimliği.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
AgentUpgradeConfig	object	Cloud Assistant Agent yükseltme yapılandırması.
AllowedUpgradeWindows	object
AllowedUpgradeWindow	array	İzin verilen yükseltme zaman pencerelerinin listesi.
	string	İzin verilen yükseltme zaman pencerelerinin listesi.	[ "02:00-03:00", "05:00-06:00" ]
BootstrapUpgrade	boolean	Cloud Assistant Agent'ın başlatıldıktan hemen sonra güncellemeleri kontrol edip etmediğini ve gerçekleştirip gerçekleştirmediğini gösterir.	true
DisableUpgrade	boolean	Cloud Assistant Agent'ın güncellemeleri kontrol etmesinin ve gerçekleştirmesinin engellenip engellenmediğini gösterir.	true
Enabled	boolean	Özel Agent yükseltme yapılandırmasının etkin olup olmadığını gösterir. Sorgu sonucunun false veya boş olması durumunda, her 30 dakikada bir yükseltme denemesi yapma varsayılan davranışı korunur.	true
TimeZone	string	İzin verilen yükseltme zaman pencerelerinin saat dilimi.	Asia/Shanghai
OssDeliveryConfigs	object
OssDeliveryConfig	array<object>	OSS teslim yapılandırmalarının listesi.
	object	OSS teslim yapılandırma bilgileri.
BucketName	string	OSS bucket'ının adı.	example-bucket
DeliveryType	string	Teslim türü. Geçerli değerler: SessionManager: Oturum işlem günlükleri. Invocation: Görev yürütme günlükleri.	SessionManager
Enabled	boolean	OSS'ye teslimin etkin olup olmadığını gösterir.	false
EncryptionAlgorithm	string	OSS şifreleme algoritması. Geçerli değerler: AES256 SM4	AES256
EncryptionKeyId	string	Şifreleme yöntemi KMS olduğunda kullanılan müşteri ana anahtarı (CMK) kimliği.	a807****7a70e
EncryptionType	string	OSS şifreleme yöntemi. Geçerli değerler: Inherit: Bucket'tan devralınır. OssManaged: Tamamen OSS tarafından yönetilir. KMS: KMS şifrelemesi.	Inherit
Prefix	string	OSS bucket'ının dizin öneki.	sessionmanager/audit
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ResourceUsageConfig	object	Cloud Assistant kaynak kullanımı yapılandırması.
CpuLimit	integer	Cloud Assistant Agent ana işlemi için izin verilen maksimum CPU kullanımı.	20
KeepScriptFile	boolean	Komut yürütme işlemi tamamlandıktan sonra betik dosyasının Cloud Assistant dizininde tutulup tutulmayacağını gösterir.	false
LogFileCountLimit	integer	Tutulacak maksimum Cloud Assistant günlük dosyası sayısı.	30
LogSizeLimit	string	Cloud Assistant günlük dosyalarının boyut sınırı.	100MB
MemoryLimit	string	Cloud Assistant Agent ana işlemi için izin verilen maksimum bellek kullanımı.	35MB
OverloadLimit	integer	CPU veya bellek kaynağı kullanımının sınırı aşabileceği maksimum ardışık sayı. Bu sınıra ulaşıldığında, Cloud Assistant Agent çalışmayı otomatik olarak durdurur.	3
SessionManagerConfig	object	Cloud Assistant oturum özelliği yapılandırması.
SessionManagerEnabled	boolean	Cloud Assistant oturum özelliği anahtarı. Geçerli değerler: true: Etkin. false: Devre dışı. Dikkat edilecek hususlar: Oturum özelliğini etkinleştirmek veya devre dışı bırakmak tüm bölgelerde etkili olur.	true
SlsDeliveryConfigs	object
SlsDeliveryConfig	array<object>	SLS teslim yapılandırmalarının listesi.
	object	SLS teslim yapılandırma bilgileri.
DeliveryType	string	Teslim türü. Geçerli değerler: SessionManager: Oturum işlem günlükleri. Invocation: Görev yürütme günlükleri.	SessionManager
Enabled	boolean	SLS'ye teslimin etkin olup olmadığını gösterir.	false
LogstoreName	string	SLS Logstore'unun adı.	example-logstore
ProjectName	string	SLS projesinin adı.	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
400	InvalidParameter.SettingType	The specified parameter SettingType is not valid.
500	InternalError	An error occurred when you dispatched the request.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
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.