ListOSSIngestions - 列出OSS导入任务

更新时间:2025-03-28 03:45:05

列出指定Project下的OSS导入任务。

调试

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

授权信息

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

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

请求语法

GET /ossingestions HTTP/1.1

请求参数

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

Project 名称

ali-test-project
offsetinteger

查询开始行。默认值为 0。

0
sizeinteger

单次查询需要获取的 OSS 导入任务数量

10

返回参数

名称类型描述示例值
名称类型描述示例值
headersobject
Serverstring

服务器名称。

nginx
Content-Typestring

返回的响应体的内容格式。

application/json
Content-Lengthstring

响应内容长度。

0
Connectionstring

是否长链接。取值包括: close:不是长链接,则每个 HTTP 请求都会重新建立 TCP 连接。 keep-alive:长链接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。

close
x-log-requestidstring

服务端产生的标识,该请求的唯一 ID。

5B0A6B60BB6EE39764D458B5
object

Schema of Response

totalinteger

指定 Project 下 OSS 导入任务数量

80
countinteger

当前列出的 OSS 导入任务数量

10
resultsarray

具体 OSS 导入任务列表

OSSIngestion

OSS 导入任务配置

示例

正常返回示例

JSON格式

{
  "total": 80,
  "count": 10,
  "results": [
    {
      "name": "ingest-oss-123456",
      "description": "oss ingestion",
      "displayName": "oss ingestion",
      "schedule": {
        "type": "Cron",
        "cronExpression": "0/5 * * * *",
        "runImmediately": false,
        "timeZone": "+0800",
        "delay": 4,
        "interval": "1m"
      },
      "configuration": {
        "logstore": "myLogstore",
        "source": {
          "endpoint": "oss-cn-hangzhou.aliyuncs.com",
          "bucket": "ossbucket",
          "compressionCodec": "none",
          "encoding": "UTF-8",
          "format": {
            "key": "{\"type\": \"Line\"}"
          },
          "interval": "never",
          "pattern": ".*",
          "prefix": "prefix",
          "restoreObjectEnabled": true,
          "startTime": 1714274081,
          "endTime": 1714360481,
          "timeField": "__time__",
          "timeFormat": "yyyy-MM-dd HH:mm:ss",
          "timePattern": "[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+",
          "timeZone": "GMT+08:00",
          "useMetaIndex": false,
          "roleARN": "acs:ram::12345:role/aliyunlogdefaultrole"
        }
      },
      "createTime": 1714360481,
      "lastModifiedTime": 1714360481,
      "status": "RUNNING",
      "scheduleId": "c7f01719d9feb105fc9d8df92af62010"
    }
  ]
}

错误码

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

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码