全部產品
Search

搜尋本產品

    Elastic Compute Service：DescribeCloudAssistantSettings - 查詢雲助手服務配置

    文件中心

    Elastic Compute Service：DescribeCloudAssistantSettings - 查詢雲助手服務配置

    更新時間：Apr 01, 2026

    查詢雲助手服務配置。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ecs:DescribeCloudAssistantSettings

    list

    *ServiceSettings

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    SettingType

    array

    是

    待查詢的服務配置列表。

    string

    否

    待查詢的服務配置類型。當前取值範圍：

    • SessionManagerDelivery：會話操作記錄投遞。

    • InvocationDelivery：任務執行記錄投遞。

    • AgentUpgradeConfig：雲助手 Agent 升級配置。

    • SessionManagerConfig: 雲助手 SessionManager 配置。

    SessionManagerDelivery
    RegionId

    string

    是

    地區 ID。

    cn-hangzhou

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    OssDeliveryConfigs

    object

    OssDeliveryConfig

    array<object>

    OSS 投遞配置列表。

    object

    OSS 投遞配置資訊。

    EncryptionType

    string

    OSS 加密方式，可能值：

    • Inherit：繼承 Bucket；

    • OssManaged：OSS 完全託管；

    • KMS：KMS 加密。

    Inherit
    EncryptionAlgorithm

    string

    OSS 密碼編譯演算法，可能值：

    • AES256

    • SM4

    AES256
    DeliveryType

    string

    投遞類型，可能值：

    • SessionManager：會話操作記錄。

    • Invocation：任務執行記錄。

    SessionManager
    Enabled

    boolean

    是否開啟投遞到 OSS 功能。

    false
    BucketName

    string

    OSS 儲存空間名稱。

    example-bucket
    Prefix

    string

    OSS 儲存空間目錄首碼。

    sessionmanager/audit
    EncryptionKeyId

    string

    加密方式為 KMS 時，使用者的主要金鑰 CMK ID。

    a807****7a70e
    SlsDeliveryConfigs

    object

    SlsDeliveryConfig

    array<object>

    SLS 投遞配置列表。

    object

    SLS 投遞配置資訊。

    DeliveryType

    string

    投遞類型，可能值：

    • SessionManager：會話操作記錄。

    • Invocation：任務執行記錄。

    SessionManager
    LogstoreName

    string

    SLS 日誌庫名稱。

    example-logstore
    Enabled

    boolean

    是否開啟投遞到 SLS 功能。

    false
    ProjectName

    string

    SLS 專案名稱。

    example-project
    AgentUpgradeConfig

    object

    雲助手 Agent 升級配置。

    Enabled

    boolean

    是否開啟自訂 Agent 升級配置。如查詢結果為 false 或空，預設保持每 30 分鐘嘗試升級一次。

    true
    AllowedUpgradeWindows

    object

    AllowedUpgradeWindow

    array

    允許升級的時間段列表。

    string

    允許升級的時間段列表。

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

    string

    允許升級時間段的時區。

    Asia/Shanghai
    BootstrapUpgrade

    boolean

    是否在雲助手 Agent 啟動時立即檢查和進行更新。

    true
    DisableUpgrade

    boolean

    是否禁止雲助手 Agent 檢查和進行更新。

    true
    ResourceUsageConfig

    object

    雲助手資源佔用配置。

    CpuLimit

    integer

    雲助手 Agent 主進程最大允許的 CPU 佔用限制。

    20
    MemoryLimit

    string

    雲助手 Agent 主進程最大允許的記憶體佔用限制。

    35MB
    OverloadLimit

    integer

    CPU 或記憶體資源佔用連續超限次數上限，達到上限後雲助手 Agent 自動終止運行。

    3
    LogFileCountLimit

    integer

    雲助手記錄檔的最大儲存數量。

    30
    LogSizeLimit

    string

    雲助手記錄檔的大小限制。

    100MB
    KeepScriptFile

    boolean

    命令執行完成後，是否保留指令檔到雲助手目錄。

    false
    SessionManagerConfig

    object

    雲助手會話功能配置。

    SessionManagerEnabled

    boolean

    雲助手會話功能開關。取值範圍：

    • true: 開啟；

    • false: 關閉。

    注意事項：

    • 會話功能開啟/關閉對全部地區生效。

    true

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameter.SettingType The specified parameter SettingType is not valid. 指定的參數SettingType不合法。
    500 InternalError An error occurred when you dispatched the request. 發送請求時發生錯誤，請稍後重試。
    404 InvalidRegionId.NotFound The specified parameter RegionId does not exist. 指定的地區ID不存在。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。