DescribeRecords_视图计算_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

说明 截图查询目前不支持分页,仅支持按迭代方式。使用返回结果里的 extStartTime 参数值,作为新请求的 StartTime 可请求下一页。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
vs:DescribeRecords
Get
全部资源
*

请求参数

字段名称字段详情
Typestring

按存储记录类型查询。取值范围:展开详情

示例值:record枚举值:recordsnapshot
StreamIdstring

按流 ID 查询。

示例值:323*****997-cn-qingdao
StartTimestring

按开始时间查询。

示例值:2021-11-22T00:00:00Z
EndTimestring

按结束时间查询。

示例值:2021-11-24T00:00:00Z
PrivateBucketboolean

是否使用私有 Bucket。

示例值:true
SortBystring

按给定字段排序,取值范围:展开详情

示例值:Id
SortDirectionstring

排序方式。取值范围:展开详情

示例值:asc枚举值:ascdesc
PageSizeinteger<int64>

分页大小,默认值:20。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:20
PageNuminteger<int64>

第几个分页,默认值:1。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1

返回参数

字段名称字段详情
PageNuminteger<int64>

第几个分页。展开详情

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1
RequestIdstring

请求 ID。

示例值:BEA5625F-8FCF-48F4-851B-CA63946DA664
NextStartTimestring

查询下个记录的开始时间。展开详情

示例值:2018-12-10T11:00:00Z
PageSizeinteger<int64>

分页大小。展开详情

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:20
TotalCountinteger<int64>

存储记录总数。展开详情

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:100
PageCountinteger<int64>

分页总数。展开详情

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:5
Recordsarray<object>

存储记录列表。

返回示例

变更历史

暂无变更历史

相关示例

2024年08月20日