すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeCloudAssistantSettings

    ドキュメントセンター

    Elastic Compute Service:DescribeCloudAssistantSettings

    最終更新日:Apr 01, 2026

    クラウドアシスタントのサービス構成の概要。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecs:DescribeCloudAssistantSettings

    list

    *ServiceSettings

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SettingType

    array

    必須

    クエリするサービス構成のタイプ。

    string

    任意

    サービス構成のタイプ。有効値：

    • SessionManagerDelivery：セッション操作レコードの配信を制御します。

    • InvocationDelivery：コマンド実行レコードの配信を制御します。

    • AgentUpgradeConfig：クラウドアシスタントエージェントのアップグレードを制御します。

    • SessionManagerConfig：クラウドアシスタントセッションマネージャーの設定を制御します。

    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：バケットの暗号化設定を継承します。

    • OssManaged：OSS マネージドキーによるサーバーサイド暗号化を使用します。

    • KMS：Key Management Service (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

    EncryptionType が KMS に設定されている場合のカスタマーマスターキー (CMK) の ID。

    a807****7a70e
    SlsDeliveryConfigs

    object

    SlsDeliveryConfig

    array<object>

    SLS 配信設定のリスト。

    object

    SLS 配信設定。

    DeliveryType

    string

    配信タイプ。有効値：

    • SessionManager：セッションマネージャーでの操作レコード。

    • Invocation：コマンド実行のレコード。

    SessionManager
    LogstoreName

    string

    SLS Logstore の名前。

    example-logstore
    Enabled

    boolean

    SLS への配信が有効になっているかどうかを示します。

    false
    ProjectName

    string

    SLS プロジェクトの名前。

    example-project
    AgentUpgradeConfig

    object

    クラウドアシスタントエージェントのアップグレード設定。

    Enabled

    boolean

    カスタムエージェントアップグレード設定が有効になっているかどうかを示します。このパラメーターが false または指定されていない場合、エージェントはデフォルトで 30 分ごとにアップグレードを試みます。

    true
    AllowedUpgradeWindows

    object

    AllowedUpgradeWindow

    array

    許可されたアップグレードタイムウィンドウ。

    string

    アップグレードタイムウィンドウ。

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

    string

    許可されたアップグレードタイムウィンドウのタイムゾーン。

    Asia/Shanghai
    BootstrapUpgrade

    boolean

    クラウドアシスタントエージェントが起動時にアップグレードを確認して実行するかどうかを示します。

    true
    DisableUpgrade

    boolean

    クラウドアシスタントエージェントの自動アップグレードを無効にするかどうかを示します。

    true
    ResourceUsageConfig

    object

    クラウドアシスタントのリソース使用量設定。

    CpuLimit

    integer

    メインのクラウドアシスタントエージェントプロセスの最大 CPU 使用率制限。

    20
    MemoryLimit

    string

    メインのクラウドアシスタントエージェントプロセスの最大メモリ使用量制限。

    35MB
    OverloadLimit

    integer

    CPU またはメモリの使用量が指定された制限を超えることができる連続最大回数。この回数に達すると、クラウドアシスタントエージェントは停止します。

    3
    LogFileCountLimit

    integer

    保持するクラウドアシスタントのログファイルの最大数。

    30
    LogSizeLimit

    string

    各クラウドアシスタントのログファイルのサイズ制限。

    100MB
    KeepScriptFile

    boolean

    コマンドの実行が完了した後、クラウドアシスタントディレクトリにスクリプトファイルを保持するかどうかを示します。

    false
    SessionManagerConfig

    object

    クラウドアシスタントセッションマネージャーの設定。

    SessionManagerEnabled

    boolean

    セッションマネージャーが有効になっているかどうかを示します。有効値：

    • true：有効。

    • false：無効。

    注意：

    • この設定はすべてのリージョンで有効になります。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。