You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

资源管理

最近更新时间2023.09.01 17:36:39

首次发布时间2023.02.09 16:29:40

阅读本文,您可以快速了解资源管理 Python SDK 的使用方法。

说明

以下 SDK 示例中仅展示了部分参数,您可以在 veImageX 的接口文档中查看该接口支持的全部参数及取值。

初始化

调用接口前请先完成初始化,具体操作请参考初始化

文件上传

以下内容用于通过指定服务 ID 和上传文件,来获取上传成功的资源 URI。

该接口内部依次调用了 ApplyImageUpload 和 CommitImageUpload 两个 OpenAPI 来实现完整文件上传能力。我们同时在 GitHub 上提供了参考示例

具体示例如下所示:

from __future__ import print_function
from volcengine.imagex.ImageXService import ImageXService

if __name__ == '__main__':
    imagex_service = ImageXService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    imagex_service.set_ak('ak')
    imagex_service.set_sk('sk')

    params = dict()
    params['ServiceId'] = 'imagex service id'
    params['SkipMeta'] = False
    params['SkipCommit'] = False
    file_paths = ['image file path 1']
    resp = imagex_service.upload_image(params, file_paths)
    print(resp)

    img_datas = ['image data 1']
    resp = imagex_service.upload_image_data(params, img_datas)
    print(resp)

删除服务下多个文件

通过指定服务 ID 以及已上传文件的 Uri 列表,来删除指定的文件。

具体接口参数和返回字段请参考 DeleteImageUploadFiles。我们同时在 GitHub 上提供了参考示例

具体示例如下所示:

from __future__ import print_function
from volcengine.imagex.ImageXService import ImageXService

if __name__ == '__main__':
    imagex_service = ImageXService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    imagex_service.set_ak('ak')
    imagex_service.set_sk('sk')

    resp = imagex_service.delete_images("imagex service id", ["image uri 1"])
    print(resp)

获取图片信息

以下内容用于通过指定服务 ID 以及已上传的文件 URI,来获取上传文件的详细信息,如:文件修改时间和文件字节数等。
具体接口参数和返回字段请参考 GetImageUploadFile。我们同时在 GitHub 上提供了参考示例
具体示例如下所示:

# coding:utf-8
from __future__ import print_function

from volcengine.imagex.ImageXService import ImageXService

if __name__ == '__main__':
    imagex_service = ImageXService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    imagex_service.set_ak('ak')
    imagex_service.set_sk('sk')

    resp = imagex_service.get_image_info('imagex service id', 'image uri')
    print(resp)

创建刷新/预热/禁用/解禁任务

本接口支持在指定服务 ID 、待更改操作的文件和文件操作类型(刷新 URL、刷新目录、预热 URL、禁用 URL 和解禁 URL)后创建相关文件务。

具体接口参数和返回字段请参考 CreateImageContentTask。我们同时在 GitHub 上提供了参考示例

具体示例如下所示:

# coding:utf-8
from __future__ import print_function

from volcengine.imagex.ImageXService import ImageXService

if __name__ == '__main__':
    imagex_service = ImageXService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    imagex_service.set_ak('ak')
    imagex_service.set_sk('sk')

    args = {'ServiceId': '',
            'TaskType': 'block_url',
            'Urls': ['1'],
            }

    resp = imagex_service.create_image_content_task(args)
    print(resp)

获取任务详情

本接口支持查询近 30 天内刷新/预热/禁用/解禁任务详情列表。

具体接口参数和返回字段请参考 GetImageContentTaskDetail。我们同时在 GitHub 上提供了参考示例

具体示例如下所示:

# coding:utf-8
from __future__ import print_function

from volcengine.imagex.ImageXService import ImageXService

if __name__ == '__main__':
    imagex_service = ImageXService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    imagex_service.set_ak('ak')
    imagex_service.set_sk('sk')

    args = {'ServiceId': '',
            'TaskType': 'refresh_url',
            'StartTime': 0,
            'EndTime': 2147483647,
            }

    resp = imagex_service.get_image_content_task_detail(args)
    print(resp)

获取禁用 URL 列表详情

本接口支持获取近 30 天内的已被禁用的 URL 列表详情,若 URL 解禁成功,则无法被查询。

具体接口参数和返回字段请参考 GetImageContentBlockList。我们同时在 GitHub 上提供了参考示例

具体示例如下所示:

# coding:utf-8
from __future__ import print_function

from volcengine.imagex.ImageXService import ImageXService

if __name__ == '__main__':
    imagex_service = ImageXService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    imagex_service.set_ak('ak')
    imagex_service.set_sk('sk')

    args = {'ServiceId': '',
            'StartTime': 0,
            'EndTime': 2147483647,
            }

    resp = imagex_service.get_image_content_block_list(args)
    print(resp)

数据抓取(Fetch)

以下内容用于指定公网可访问的待迁移资源 URL 以及迁移目标服务 ID,来对资源进行迁移,并得到迁移后的资源 URI 等信息,并获取异步抓取任务详情。

具体接口参数和返回字段请参考 FetchImageUrlGetUrlFetchTask。我们同时在 GitHub 上提供了参考示例

具体示例如下所示:

# coding:utf-8
from __future__ import print_function
from volcengine.imagex.ImageXService import ImageXService

if __name__ == '__main__':
    imagex_service = ImageXService()

    # call below method if you dont set ak and sk in $HOME/.volc/config
    imagex_service.set_ak('ak')
    imagex_service.set_sk('sk')

    req1 = {
        'ServiceId': 'imagex service id',
        'Url': 'image uri',
        # 'Async': True,
    }
    resp1 = imagex_service.fetch_image_url(req1)
    print(resp1)

    if 'TaskId' not in resp1:
        exit()

    req2 = {
        'ServiceId': req1['ServiceId'],
        'Id': resp1['TaskId'],
    }
    resp2 = imagex_service.get_url_fetch_task(req2)
    print(resp2)