如何通过SDK接口列出OSS导入任务_日志服务(SLS)-阿里云帮助中心

前提条件

已开通日志服务。
已安装Python、Python开发环境（例如PyCharm）和Python的包管理工具pip。
- 日志服务Python SDK新版支持Python3.7及以上版本。
- 您可以执行python -V命令检查已安装的Python版本。
- 您可以执行pip3 -V命令检查您已安装的pip版本。
已安装日志服务Python SDK新版。
- 在命令行工具中，执行如下命令完成安装。
```
pip install alibabacloud_sls20201230
```
- 安装SDK新版后，执行如下命令进行验证。
```
pip show alibabacloud_sls20201230
```
已配置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。具体操作，请参见在Linux、macOS和Windows系统中配置环境变量。

参数说明

def list_ossingestions(
        self,
        project: str,
        request: sls_20201230_models.ListOSSIngestionsRequest,
) -> sls_20201230_models.ListOSSIngestionsResponse:

请求参数

名称	类型	是否必填	描述	示例值

名称	类型	是否必填	描述	示例值
project	String	是	Project名称。	ali-test-project
request	object	是	获取OSS导入任务实体。	-

request参数说明：

class ListOSSIngestionsRequest(TeaModel):
    def __init__(
        self,
        logstore: str = None,
        offset: int = None,
        size: int = None,
    ):

名称	类型	是否必填	描述	示例值

名称	类型	是否必填	描述	示例值
logstore	String	否	Logstore名称。	test-logstore
offset	int	否	查询开始行。默认值为 0。	0
size	int	否	单次查询需要获取的 OSS 导入任务数量。	10

返回参数

返回参数说明，请参见ListOSSIngestions - 列出OSS导入任务。

示例代码

import os

from alibabacloud_sls20201230.client import Client as Sls20201230Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_sls20201230 import models as sls_20201230_models
from alibabacloud_tea_util.client import Client as UtilClient


def main():
    config = open_api_models.Config(
        # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
        access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
        # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
        access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
    )
    # 日志服务的服务接入点
    config.endpoint = "cn-hangzhou.log.aliyuncs.com"
    project_name = "ali-test-project"
    client = Sls20201230Client(config)
    request = sls_20201230_models.ListOSSIngestionsRequest()
    try:
        list_ossingestions_response = client.list_ossingestions(project_name, list_ossingestions_request)
        print(list_ossingestions_response)
    except Exception as error:
        print(error.message)
        print(error.data.get("Recommend"))
        UtilClient.assert_as_string(error.message)


if __name__ == '__main__':
    main()

示例返回结果

{'headers': {'server': 'AliyunSLS', 'content-type': 'application/json', 'content-length': '1358', 'connection': 'keep-alive', 'access-control-allow-origin': '*', 'date': 'Thu, 31 Oct 2024 08:35:51 GMT', 'x-log-time': '1730363751', 'x-log-requestid': '6723416702F16E98DF4641C2'}, 'statusCode': 200, 'body': {'count': 2, 'results': [{'configuration': {'logstore': 'test-logstore1', 'source': {'bucket': 'oss-test-shanghai001', 'compressionCodec': 'none', 'encoding': 'UTF-8', 'endpoint': 'cn-shanghai-internal.aliyuncs.com', 'format': {'type': 'Line'}, 'interval': '30s', 'useMetaIndex': False}}, 'createTime': 1730359624, 'description': '这是一个描述', 'displayName': 'OSS导入测试', 'lastModifiedTime': 1730359624, 'name': 'ingest-oss-123456', 'schedule': {'type': 'Resident'}, 'scheduleId': 'e64359bc****901d57bfb8e935ebca09', 'status': 'RUNNING'}, {'configuration': {'logstore': 'test-logstore2', 'source': {'bucket': 'oss-test-hangzhou001', 'compressionCodec': 'none', 'encoding': 'UTF-8', 'endpoint': 'oss-cn-hangzhou-internal.aliyuncs.com', 'format': {'type': 'Line'}, 'interval': '30m', 'pattern': '', 'prefix': '', 'restoreObjectEnabled': False, 'timeField': '', 'timeFormat': '', 'timePattern': '', 'timeZone': '', 'useMetaIndex': False}}, 'createTime': 1730357727, 'description': '这是一个描述', 'displayName': 'test', 'lastModifiedTime': 1730357727, 'name': 'ingest-oss-17*****487-54**77', 'schedule': {'type': 'Resident'}, 'scheduleId': '8f9cbc2bc044****3750b65d1a8180c3', 'status': 'RUNNING'}], 'total': 2}}

Process finished with exit code 0

前提条件

参数说明

请求参数

返回参数

示例代码

示例返回结果

相关文档