DescribeCloudAssistantSettings - - Alibaba Cloud Documentation Center

Ikhtisar 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	Jenis konfigurasi layanan yang akan dikueri.
	string	No	Jenis konfigurasi layanan. Nilai yang valid: SessionManagerDelivery: Mengontrol pengiriman catatan operasi sesi. InvocationDelivery: Mengontrol pengiriman catatan eksekusi perintah. AgentUpgradeConfig: Mengontrol peningkatan untuk Cloud Assistant Agent. SessionManagerConfig: Mengontrol pengaturan untuk Cloud Assistant SessionManager.	SessionManagerDelivery
RegionId	string	Yes	ID wilayah.	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	Konfigurasi pengiriman OSS.
EncryptionType	string	Jenis enkripsi untuk pengiriman OSS. Nilai yang valid: `Inherit`: Mewarisi pengaturan enkripsi bucket. `OssManaged`: Menggunakan enkripsi sisi server dengan kunci yang dikelola OSS. `KMS`: Menggunakan enkripsi Key Management Service (KMS).	Inherit
EncryptionAlgorithm	string	Algoritma enkripsi untuk pengiriman OSS. Nilai yang valid: `AES256` `SM4`	AES256
DeliveryType	string	Jenis pengiriman. Nilai yang valid: `SessionManager`: Catatan operasi di Session Manager. `Invocation`: Catatan invokasi perintah.	SessionManager
Enabled	boolean	Menunjukkan apakah pengiriman ke OSS diaktifkan.	false
BucketName	string	Nama bucket OSS.	example-bucket
Prefix	string	Awalan direktori di bucket OSS.	sessionmanager/audit
EncryptionKeyId	string	ID Customer Master Key (CMK) saat `EncryptionType` diatur ke `KMS`.	a807****7a70e
SlsDeliveryConfigs	object
SlsDeliveryConfig	array<object>	Daftar konfigurasi pengiriman SLS.
	object	Konfigurasi pengiriman SLS.
DeliveryType	string	Jenis pengiriman. Nilai yang valid: `SessionManager`: Catatan operasi di Session Manager. `Invocation`: Catatan invokasi perintah.	SessionManager
LogstoreName	string	Nama Logstore SLS.	example-logstore
Enabled	boolean	Menunjukkan apakah pengiriman ke SLS diaktifkan.	false
ProjectName	string	Nama Proyek SLS.	example-project
AgentUpgradeConfig	object	Konfigurasi peningkatan agen Cloud Assistant.
Enabled	boolean	Menunjukkan apakah pengaturan peningkatan agen kustom diaktifkan. Jika parameter ini bernilai `false` atau tidak ditentukan, agen akan mencoba melakukan peningkatan setiap 30 menit secara default.	true
AllowedUpgradeWindows	object
AllowedUpgradeWindow	array	Jendela waktu peningkatan yang diizinkan.
	string	Jendela waktu peningkatan.	[ "02:00-03:00", "05:00-06:00" ]
TimeZone	string	Zona waktu untuk jendela waktu peningkatan yang diizinkan.	Asia/Shanghai
BootstrapUpgrade	boolean	Menunjukkan apakah agen Cloud Assistant memeriksa dan melakukan peningkatan saat startup.	true
DisableUpgrade	boolean	Menunjukkan apakah peningkatan otomatis untuk agen Cloud Assistant dinonaktifkan.	true
ResourceUsageConfig	object	Konfigurasi penggunaan sumber daya Cloud Assistant.
CpuLimit	integer	Batas maksimum penggunaan CPU untuk proses utama agen Cloud Assistant.	20
MemoryLimit	string	Batas maksimum penggunaan memori untuk proses utama agen Cloud Assistant.	35MB
OverloadLimit	integer	Jumlah maksimum kali berturut-turut penggunaan CPU atau memori dapat melebihi batas yang ditentukan. Jika jumlah ini tercapai, agen Cloud Assistant akan berhenti.	3
LogFileCountLimit	integer	Jumlah maksimum file log Cloud Assistant yang disimpan.	30
LogSizeLimit	string	Batas ukuran untuk setiap file log Cloud Assistant.	100MB
KeepScriptFile	boolean	Menunjukkan apakah file skrip tetap disimpan di direktori Cloud Assistant setelah perintah selesai dieksekusi.	false
SessionManagerConfig	object	Konfigurasi Cloud Assistant Session Manager.
SessionManagerEnabled	boolean	Menunjukkan apakah Session Manager diaktifkan. Nilai yang valid: `true`: Diaktifkan. `false`: Dinonaktifkan. Catatan: Pengaturan ini berlaku di semua wilayah.	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.