すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:ModifyCloudAssistantSettings

    ドキュメントセンター

    Elastic Compute Service:ModifyCloudAssistantSettings

    最終更新日:Apr 27, 2026

    Cloud Assistant の設定を変更します。

    今すぐお試しください

    この 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:ModifyCloudAssistantSettings

    update

    *ServiceSettings

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。

    cn-hangzhou
    SettingType

    string

    必須

    サービス設定のタイプ。有効な値：

    • SessionManagerDelivery：セッション記録の配信設定。

    • InvocationDelivery：コマンド実行記録の配信設定。

    • AgentUpgradeConfig：Cloud Assistant エージェントのアップグレード設定。

    • SessionManagerConfig：Cloud Assistant セッションマネージャーの設定。

    SessionManagerDelivery
    OssDeliveryConfig

    object

    任意

    OSS への記録の配信設定。

    Enabled

    boolean

    任意

    OSS への記録の配信機能を有効にするかどうかを指定します。デフォルト値： false。

    false
    BucketName

    string

    任意

    OSS バケット名。

    example-bucket
    Prefix

    string

    任意

    OSS バケット内のディレクトリのプレフィックス。次の制限があります：

    • プレフィックスの長さは 254 文字までです。

    • プレフィックスをフォワードスラッシュ (/) またはバックスラッシュ (\\) で始めることはできません。

    注：バケットのルートディレクトリに記録を配信する場合は、「""」と入力します。以前に設定したプレフィックスをクリアするには、「""」と入力します。

    sessionmanager/audit
    EncryptionType

    string

    任意

    OSS の暗号化モード。有効な値：

    • Inherit：バケットの暗号化を継承します。

    • OssManaged：OSS マネージドのサーバー側暗号化を使用します。

    • KMS：KMS 暗号化を使用します。

    Inherit
    EncryptionAlgorithm

    string

    任意

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

    • AES256

    • SM4

    AES256
    EncryptionKeyId

    string

    任意

    KMS 暗号化を使用する場合のカスタマーマスターキー (CMK) ID。

    a807****7a70e
    SlsDeliveryConfig

    object

    任意

    SLS への記録の配信設定。

    Enabled

    boolean

    任意

    SLS への記録の配信機能を有効にするかどうかを指定します。デフォルト値： false。

    false
    ProjectName

    string

    任意

    SLS プロジェクト名。

    example-project
    LogstoreName

    string

    任意

    SLS ログストア名。

    example-logstore
    AgentUpgradeConfig

    object

    任意

    Cloud Assistant エージェントのアップグレード設定。

    Enabled

    boolean

    任意

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

    デフォルト値： false。

    true
    AllowedUpgradeWindow

    array

    任意

    エージェントのアップグレードが許可される時間ウィンドウのリスト。時間ウィンドウは分単位で、デフォルトのタイムゾーンは UTC です。

    連続する 2 つの時間ウィンドウの間隔は 1 時間以上である必要があります。

    フォーマット： StartTime(HH:mm)-EndTime(HH:mm)。

    例：[ "02:00-03:00", "05:00-06:00" ] は、エージェントが毎日 UTC の 2:00 から 3:00 と 5:00 から 6:00 にアップグレードできることを示します。

    string

    任意

    エージェントのアップグレードが許可される時間ウィンドウのリスト。時間ウィンドウは分単位で、デフォルトのタイムゾーンは UTC です。

    連続する 2 つの時間ウィンドウの間隔は 1 時間以上である必要があります。

    フォーマット： StartTime(HH:mm)-EndTime(HH:mm)。

    例：[ "02:00-03:00", "05:00-06:00" ] は、エージェントが毎日 UTC の 2:00 から 3:00 と 5:00 から 6:00 にアップグレードできることを示します。

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

    string

    任意

    エージェントアップグレードの時間ウィンドウのタイムゾーン。デフォルト値： UTC。 タイムゾーンは、次の形式をサポートします：

    • タイムゾーン名：例： Asia/Shanghai (中国/上海時間)、America/Los_Angeles (米国/ロサンゼルス時間)。

    • グリニッジ標準時 (GMT) からのオフセット：例： GMT+8:00 (UTC+8)、GMT-7:00 (UTC-7)。時間の部分に先行ゼロは付けられません。

    Asia/Shanghai
    BootstrapUpgrade

    boolean

    任意

    Cloud Assistant エージェントの起動時に、即座にバージョンを確認して更新を実行するかどうかを指定します。デフォルト値： true。

    この設定は、Cloud Assistant エージェントのバージョンが次のバージョン以降の場合にのみ有効です：

    • Windows： 2.1.4.1065

    • Linux： 2.2.4.1065

    true
    DisableUpgrade

    boolean

    任意

    Cloud Assistant エージェントによる更新の確認や実行を禁止するかどうかを指定します。デフォルト値： false。

    この設定は、Cloud Assistant エージェントのバージョンが次のバージョン以降の場合にのみ有効です：

    • Windows： 2.1.4.1065

    • Linux： 2.2.4.1065

    false
    ResourceUsageConfig

    object

    任意

    Cloud Assistant のリソース使用量の設定。この設定は、Cloud Assistant エージェントのバージョンが次のバージョン以降の場合にのみ有効です：

    • Windows： 2.1.4.1065

    • Linux： 2.2.4.1065

    CpuLimit

    integer

    任意

    Cloud Assistant エージェントのメインプロセスで許容される最大の CPU 使用率。

    • 単位：%

    • 有効な値： 10～95。

    • デフォルト値： 20。

    20
    MemoryLimit

    string

    任意

    Cloud Assistant エージェントのメインプロセスで許容される最大のメモリ使用量。単位 (B、KB、MB) を指定する必要があります。

    • デフォルト値：50 MB。

    • 最小値：35 MB。

    • 最大値：1024 MB。

    50MB
    OverloadLimit

    integer

    任意

    CPU またはメモリの使用量が指定された制限を連続して超えることができる最大回数。指定された回数連続して制限を超えた場合、Cloud Assistant エージェントは自動的に停止します。

    • デフォルト値： 3。

    • 最小値： 3。

    3
    LogFileCountLimit

    integer

    任意

    保持できる Cloud Assistant ログファイルの最大数。

    • デフォルト値： 30。

    • 最小値： 7。

    • 最大値： 365。

    30
    LogSizeLimit

    string

    任意

    Cloud Assistant ログファイル 1 つあたりの最大サイズ。単位 (B、KB、MB) を指定する必要があります。

    • デフォルト値：100 MB。

    • 最小値：10 MB。

    • 最大値：1024 MB。

    10MB
    KeepScriptFile

    boolean

    任意

    コマンドの実行完了後に、Cloud Assistant ディレクトリにコマンドのスクリプトファイルを保持するかどうかを指定します。デフォルト値： false。

    false
    SessionManagerConfig

    object

    任意

    Cloud Assistant セッションマネージャーの設定。

    SessionManagerEnabled

    boolean

    任意

    Cloud Assistant セッションマネージャー機能の有効/無効スイッチ。有効な値：

    • true：機能を有効にします。

    • false：機能を無効にします。

    注：

    • Cloud Assistant セッションマネージャー機能を有効または無効にすると、設定はすべてのリージョンで有効になります。

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 ResourceBusy.SlrCreation The ServiceLinkedRole is still being created or has not taken effect yet. Please try again later.
    400 InvalidParameter.SettingType The specified parameter SettingType is not valid.
    400 InvalidParameter.OssEncryptionType The specified parameter OssDeliveryConfig.EncryptionType is not valid.
    400 InvalidParameter.OssEncryptionAlgorithm The specified parameter OssDeliveryConfig.EncryptionAlgorithm is not valid.
    400 InvalidParameter.OssEncryptionKeyId The specified parameter OssDeliveryConfig.EncryptionKeyId is not valid.
    400 InvalidParameter.OssBucketName The specified parameter OssDeliveryConfig.BucketName is not valid.
    400 InvalidParameter.OssPrefix The specified parameter OssDeliveryConfig.Prefix is not valid.
    400 InvalidOssBucketName.InOtherRegion The specified parameter OssDeliveryConfig.BucketName is in another region.
    400 InvalidParameter.SlsProjectName The specified parameter SlsDeliveryConfig.ProjectName is not valid.
    400 InvalidParameter.SlsLogstoreName The specified parameter SlsDeliveryConfig.LogstoreName is not valid.
    400 InvalidParameter.AllowedUpgradeWindow The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is not valid.
    400 InvalidAllowedUpgradeWindow.DurationTooShort The duration of the specified parameter AgentUpgradeConfig.AllowedUpgradeWindow cannot be less than one hour.
    400 InvalidParameter.TimeZone The specified parameter AgentUpgradeConfig.TimeZone is not valid.
    400 InvalidAllowedUpgradeWindow.Required The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is required.
    400 InvalidParameter.CpuLimit The specified parameter CpuLimit is not valid.
    400 InvalidParameter.MemoryLimit The specified parameter MemoryLimit is not valid.
    400 InvalidParameter.OverloadLimit The specified parameter OverloadLimit is not valid.
    400 InvalidParameter.LogFileCountLimit The specified parameter LogFileCountLimit is not valid.
    400 InvalidParameter.LogSizeLimit The specified parameter LogSizeLimit is not valid.
    500 InternalError An error occurred when you dispatched the request.
    403 InvalidOssBucketName.AccessDenied The error message returned by the OSS API is: %s
    403 CreateServiceLinkedRole.NoPermission You do not have permission to create ServiceLinkedRole.
    403 InvalidOperation.OssEncryptionUnsupported The configuration of OSS Encryption is not supported.
    403 InvalidAllowedUpgradeWindow.CountLimitExceeded The count of the parameter AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5.
    403 InvalidOperation.SessionManagerDeliveryUnsupported The delivery configuration of Session Manager is not supported.
    403 InvalidDisableUpgrade.Conflict The parameter DisableUpgrade cannot be specified with parameter BootstrapUpgrade.
    404 InvalidSlsProjectName.NotFound The specified parameter SlsDeliveryConfig.ProjectName does not exist.
    404 InvalidSlsLogstoreName.NotFound The specified parameter SlsDeliveryConfig.LogstoreName does not exist.
    404 InvalidOssBucketName.NotFound The specified parameter OssDeliveryConfig.BucketName does not exist.
    404 InvalidRegionId.NotFound The specified parameter RegionId does not exist.

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

    変更履歴

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