API文档
容器云相关接口
异步任务接口
PythonSDK

1. 通过 PythonSDK 操作容器实例资源

本文档说明如何通过 PythonSDK 操作您的容器实例资源。

本文档中涉及到的 AccessKey 和 SecretAccessKey 只用作演示用,不作为您真实操作自己资源的依据。

本文档中涉及到的链接信息实际应为https://ai.blsc.cn (opens in a new tab)

本页所有接口都用到可用区信息,可用区具体说明详见 可用区, 本页不再重复说明

本页所有接口都用到资源规格信息,资源规格具体说明详见 资源规格, 本页不再重复说明

本页所有接口返回信息都包含异步任务信息,异步任务具体说明详见 异步任务, 本页不再重复说明

1.1. 获取异步任务信息

    # 实例化一个认证对象,入参需要传入智算云平台账户AccessKey和SecretAccessKey,此处还需注意密钥对的保密
    # 密钥可前往智算云平台->个人中心->我的密钥进行获取
    AccessKey: str = "abcd"
    SecretAccessKey: str = "abcd1234"
    clientProfile = ClientProfile(
        AccessKey,
        SecretAccessKey
    )
 
    # 实例化一个请求产品的client对象
    client = ACKJobClient(clientProfile=clientProfile)
    # 实例化一个请求对象,每个接口都会对应一个request对象
    request = DescribeJobsRequest()
    # 传入待查询异步任务id信息
    request.jobUuid = "req-00001nje7a-00x2qycn"
    # 返回的response是一个DescribeJobsResponse实例
    # 该实例有三个重要属性,分别是code、message和data
    response = client.DescribeJobs(request)
    # code属性表示本次请求返回的编码。该编码200表示正常,非200表示异常
    code = response.code
    # message属性表示本次请求返回的信息。如果code值为非200,则可通过message获得请求异常原因
    message = response.message
    # data属性为实际返回的云服务器类型信息列表。数据类型为list[Job]
    if code != 200:
        print(message)
        return
 
    jobs = response.data
    # Job类有如下重要属性
    # progress 表示异步任务执行进度,该属性数据类型为浮点,表示执行的百分比
    # done表示是否执行完成。True表示执行完成,False表示未执行完成
    # success表示是否执行成功。True表示执行成功,False表示执行失败。
    # result执行结果说明。
    done = jobs[0].done
    print(done)