すべてのプロダクト
Search
ドキュメントセンター

Elastic Compute Service:DescribeCloudAssistantSettings

最終更新日:Sep 20, 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: 会話操作ログの log delivery。

  • InvocationDelivery: タスク実行ログの log delivery。

  • AgentUpgradeConfig: クラウドアシスタントエージェントのスペックアップ構成。

  • SessionManagerConfig: クラウドアシスタント SessionManager の構成。

SessionManagerDelivery

RegionId

string

必須

リージョン ID。

cn-hangzhou

レスポンスフィールド

フィールド

型

説明

例

object

AgentUpgradeConfig

object

クラウドアシスタントエージェントのスペックアップ構成。

AllowedUpgradeWindows

object

AllowedUpgradeWindow

array

許可されたスペックアップ時間ウィンドウのリスト。

string

許可されたスペックアップ時間ウィンドウのリスト。

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

BootstrapUpgrade

boolean

クラウドアシスタントエージェントが起動直後に更新を確認して実行するかどうかを示します。

true

DisableUpgrade

boolean

クラウドアシスタントエージェントによる更新の確認と実行が禁止されているかどうかを示します。

true

Enabled

boolean

カスタムエージェントスペックアップ構成が有効かどうかを示します。クエリ結果が false または空の場合、30 分ごとにスペックアップを試行するというデフォルトの動作が維持されます。

true

TimeZone

string

許可されたスペックアップ時間ウィンドウのタイムゾーン。

Asia/Shanghai

OssDeliveryConfigs

object

OssDeliveryConfig

array<object>

OSS 配信構成のリスト。

object

OSS 配信構成情報。

BucketName

string

OSS バケットの名前。

example-bucket

DeliveryType

string

配信タイプ。有効な値:

  • SessionManager: 会話操作ログ。

  • Invocation: タスク実行ログ。

SessionManager

Enabled

boolean

OSS への配信が有効かどうかを示します。

false

EncryptionAlgorithm

string

OSS 暗号化アルゴリズム。有効な値:

  • AES256

  • SM4

AES256

EncryptionKeyId

string

暗号化メソッドが KMS の場合に使用されるカスタマーマスターキー (CMK) ID。

a807****7a70e

EncryptionType

string

OSS 暗号化メソッド。有効な値:

  • Inherit: バケットから継承。

  • OssManaged: OSS によるフルマネージド。

  • KMS: KMS 暗号化。

Inherit

Prefix

string

OSS バケットのディレクトリプレフィックス。

sessionmanager/audit

RequestId

string

リクエスト ID

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

ResourceUsageConfig

object

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

CpuLimit

integer

クラウドアシスタントエージェントのメインプロセスに許可される CPU 使用量の最大値。

20

KeepScriptFile

boolean

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

false

LogFileCountLimit

integer

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

30

LogSizeLimit

string

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

100MB

MemoryLimit

string

クラウドアシスタントエージェントのメインプロセスに許可されるメモリ使用量の最大値。

35MB

OverloadLimit

integer

CPU またはメモリリソースの使用量が制限を超えることができる連続時間の最大値。この制限に達すると、クラウドアシスタントエージェントは自動的に実行中を停止します。

3

SessionManagerConfig

object

クラウドアシスタントの会話特徴の構成。

SessionManagerEnabled

boolean

クラウドアシスタントの会話特徴のトグル。有効な値:

  • true: 有効。

  • false: 無効。

注意事項:

  • 会話特徴の有効化または無効化は、すべてのリージョンで効果があります。

true

SlsDeliveryConfigs

object

SlsDeliveryConfig

array<object>

SLS 配信構成のリスト。

object

SLS 配信構成情報。

DeliveryType

string

配信タイプ。有効な値:

  • SessionManager: 会話操作ログ。

  • Invocation: タスク実行ログ。

SessionManager

Enabled

boolean

SLS への配信が有効かどうかを示します。

false

LogstoreName

string

SLS Logstore の名前。

example-logstore

ProjectName

string

SLS プロジェクトの名前。

example-project

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter.SettingType The specified parameter SettingType is not valid. 指定された SettingType パラメーターは無効です。
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. 指定された RegionId は存在しません。このリージョンでプロダクトが利用可能かどうかを確認してください。

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

変更履歴

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