DescribeCloudAssistantSettings - Elastic Compute Service

Mengkueri konfigurasi layanan Cloud Assistant.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeCloudAssistantSettings

list

*ServiceSettings

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SettingType	array	Yes	Daftar konfigurasi layanan yang akan dikueri.
	string	No	Jenis konfigurasi layanan yang akan dikueri. Nilai yang valid: SessionManagerDelivery: pengiriman catatan operasi sesi. InvocationDelivery: pengiriman catatan eksekusi tugas. AgentUpgradeConfig: konfigurasi peningkatan Cloud Assistant Agent. SessionManagerConfig: konfigurasi Cloud Assistant SessionManager.	SessionManagerDelivery
RegionId	string	Yes	ID region.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OssDeliveryConfigs	object
OssDeliveryConfig	array<object>	Daftar konfigurasi pengiriman OSS.
	object	Informasi konfigurasi pengiriman 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 with Key Management Service (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 set to KMS.	a807****7a70e
SlsDeliveryConfigs	object
SlsDeliveryConfig	array<object>	Daftar konfigurasi pengiriman SLS.
	object	Informasi konfigurasi pengiriman SLS.
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	Konfigurasi peningkatan Cloud Assistant Agent.
Enabled	boolean	Menunjukkan apakah konfigurasi peningkatan Agent kustom diaktifkan. Jika hasil kueri false atau kosong, sistem secara default mencoba melakukan peningkatan setiap 30 menit.	true
AllowedUpgradeWindows	object
AllowedUpgradeWindow	array	The time windows during which Cloud Assistant Agent can be upgraded.
	string	The time windows during which Cloud Assistant Agent can be upgraded.	[ "02:00-03:00", "05:00-06:00" ]
TimeZone	string	Zona waktu untuk jendela waktu peningkatan yang diizinkan.	Asia/Shanghai
BootstrapUpgrade	boolean	Menunjukkan apakah akan langsung memeriksa dan melakukan pembaruan saat Cloud Assistant Agent dimulai.	true
DisableUpgrade	boolean	Menunjukkan apakah akan menonaktifkan Cloud Assistant Agent dari memeriksa dan melakukan pembaruan.	true
ResourceUsageConfig	object	Konfigurasi penggunaan sumber daya Cloud Assistant.
CpuLimit	integer	Batas penggunaan CPU maksimum yang diizinkan untuk proses utama Cloud Assistant Agent.	20
MemoryLimit	string	Batas penggunaan memori maksimum yang diizinkan untuk proses utama Cloud Assistant Agent.	35MB
OverloadLimit	integer	Batas atas jumlah kejadian berturut-turut ketika penggunaan sumber daya CPU atau memori melebihi batas. Setelah batas atas tercapai, Cloud Assistant Agent secara otomatis berhenti.	3
LogFileCountLimit	integer	Jumlah maksimum file log Cloud Assistant yang dipertahankan.	30
LogSizeLimit	string	Batas ukuran file log Cloud Assistant.	100MB
KeepScriptFile	boolean	Menunjukkan apakah akan mempertahankan file skrip di direktori Cloud Assistant setelah perintah dieksekusi.	false
SessionManagerConfig	object	Konfigurasi fitur sesi Cloud Assistant.
SessionManagerEnabled	boolean	Sakelar fitur sesi Cloud Assistant. Nilai yang valid: true: diaktifkan. false: dinonaktifkan. Catatan: Mengaktifkan atau menonaktifkan fitur sesi berlaku di semua region.	true

Contoh

Respons sukses

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",
    "BootstrapUpgrade": true,
    "DisableUpgrade": true
  },
  "ResourceUsageConfig": {
    "CpuLimit": 20,
    "MemoryLimit": "35MB",
    "OverloadLimit": 3,
    "LogFileCountLimit": 30,
    "LogSizeLimit": "100MB",
    "KeepScriptFile": false
  },
  "SessionManagerConfig": {
    "SessionManagerEnabled": true
  }
}

Kode kesalahan

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.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.