文档

DescribeLogStore - 返回用户存储的相关属性

更新时间:

返回用户侧日志服务中威胁分析使用的LogStore的相关属性,如名字、TTL等。

调试

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

授权信息

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

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

请求参数

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

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港,选择该项。
  • ap-southeast-1:资产属于海外地域,选择该项。
cn-hangzhou

返回参数

名称类型描述示例值
object

CloudSiemResponse

Dataobject

威胁分析服务返回的具体内容。

LogStoreNamestring

日志服务 LogStore 的名字。

cloud-siem
Ttlinteger

数据保存天数。

180
ShardCountinteger

日志服务分区(shard)数目。

2
EnableTrackingboolean

是否通过 Web Tracking 采集各种浏览器、iOS App 或 Android App 的用户信息,默认关闭。取值:

  • true:开启
  • false:关闭
false
AutoSplitboolean

自动分裂分区(shard)。取值:

  • true:开启
  • false:关闭
false
MaxSplitShardinteger

最大分裂数。

64
AppendMetaboolean

接收日志后,是否自动添加客户端外网 IP 和日志到达时间。取值:

  • true:自动添加客户端外网 IP 和日志到达时间
  • false:不自动添加客户端外网 IP 和日志到达时间
false
RequestIdstring

请求消息 ID。

9B9CBCEE-9225-5069-BC7F-880938A2****

示例

正常返回示例

JSON格式

{
  "Data": {
    "LogStoreName": "cloud-siem",
    "Ttl": 180,
    "ShardCount": 2,
    "EnableTracking": false,
    "AutoSplit": false,
    "MaxSplitShard": 64,
    "AppendMeta": false
  },
  "RequestId": "9B9CBCEE-9225-5069-BC7F-880938A2****"
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试

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

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:501
    新增错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)