DescribeCloudAssistantSettings - 查询云助手服务配置

更新时间:2025-02-19 03:54:13

查询云助手服务配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
ecs:DescribeCloudAssistantSettingslist
*ServiceSettings
acs:ecs:{#regionId}:{#accountId}:servicesettings/{#servicesettingId}

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
SettingTypearray

待查询的服务配置列表。

string

待查询的服务配置类型。当前取值范围:

  • SessionManagerDelivery:会话操作记录投递。
  • InvocationDelivery:任务执行记录投递。
  • AgentUpgradeConfig:云助手 Agent 升级配置。
SessionManagerDelivery
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OssDeliveryConfigsarray<object>

OSS 投递配置列表。

OssDeliveryConfigobject

OSS 投递配置信息。

EncryptionTypestring

OSS 加密方式,可能值:

  • Inherit:继承 Bucket;
  • OssManaged:OSS 完全托管;
  • KMS:KMS 加密。
Inherit
EncryptionAlgorithmstring

OSS 加密算法,可能值:

  • AES256
  • SM4
AES256
DeliveryTypestring

投递类型,可能值:

  • SessionManager:会话操作记录。
  • Invocation:任务执行记录。
SessionManager
Enabledboolean

是否开启投递到 OSS 功能。

false
BucketNamestring

OSS 存储空间名称。

example-bucket
Prefixstring

OSS 存储空间目录前缀。

sessionmanager/audit
EncryptionKeyIdstring

加密方式为 KMS 时,用户的主密钥 CMK ID。

a807****7a70e
SlsDeliveryConfigsarray<object>

SLS 投递配置列表。

SlsDeliveryConfigobject

SLS 投递配置信息。

DeliveryTypestring

投递类型,可能值:

  • SessionManager:会话操作记录。
  • Invocation:任务执行记录。
SessionManager
LogstoreNamestring

SLS 日志库名称。

example-logstore
Enabledboolean

是否开启投递到 SLS 功能。

false
ProjectNamestring

SLS 项目名称。

example-project
AgentUpgradeConfigobject

云助手 Agent 升级配置。

Enabledboolean

是否开启自定义 Agent 升级配置。如查询结果为 false 或空,默认保持每 30 分钟尝试升级一次。

true
AllowedUpgradeWindowsarray

允许升级的时间段列表。

AllowedUpgradeWindowstring

允许升级的时间段列表。

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

允许升级时间段的时区。

Asia/Shanghai

示例

正常返回示例

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

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400InvalidParameter.SettingTypeThe specified parameter SettingType is not valid.指定的参数SettingType不合法。
404InvalidRegionId.NotFoundThe specified parameter RegionId does not exist.指定的地域ID不存在。
500InternalErrorAn error occurred when you dispatched the request.发送请求时发生错误,请稍后重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等