v20150630-related-0.1a6相关说明

1. 类和常量

1.1 关于类属性

# job is a Job object.
job = ...

job_id = job.JobId
print(job_id)

• 另外，可以通过字典取值的方式获取属性，例如：

# job is a Job object.
job = ...

job_id = job['JobId']
print(job_id)

• 对于类 JobDescription, TaskDag, Task, ResourceDescription, 可以通过赋值的方式更改某个属性的值，例如：

from batchcompute import JobDescription

job_desc = JobDescription()
job_desc.JobName = 'find-prime'

• 对于类 JobDescription, TaskDag, TaskDescription, ResourceDescription, 可以通过字典的方式对类的属性进行赋值，例如：

from batchcompute import JobDescription

job_desc = JobDescription()
job_desc['JobId'] = 'find-prime'

1.2 关于可序列化

参数说明：

• 通过字典初始化 Jsonizable 类：

e.g.

from batchcompute import JobDescription

# A dict object.
properties = {
    "JobName": "find-prime",
    "JobTag": "Batchcompute"
}

jsonizable = JobDescription(properties)
print(jsonizable.JobName)
print(jsonizable.JobTag)

• 通过JSON字符串初始化 Jsonizable 类：

e.g.

from batchcompute import JobDescription

# A string jsonized from a dict object.
properties = '''{
    "JobName": "find-prime",
    "JobTag": "Batchcompute"
}'''

jsonizable = JobDescription(properties)
print(jsonizable.JobName)
print(jsonizable.JobTag)

• 通过相同类的对象初始化 Jsonizable 类：

e.g.

form batchcompute import JobDescription

# A JobDescription object.
jsonizable1 = JobDescription()
jsonizable1.JobName = 'find-prime'
jsonizable1.JobTag = 'Batchcompute'

jsonizable2 = JobDescription(jsonizable1)
print(jsonizable2.JobName)
print(jsonizable2.JobTag)

方法说明：

1.3 关于响应类

属性说明：

e.g.

...

response = client.create_job(job_desc)

print response.RequestId
print response.StatusCode

2. Client 类

参数说明：

e.g.

from batchcompute import Client, CN_QINGDAO

endpoint = CN_QINGDAO
access_key_id = ... # your_access_key_id
access_key_secret = ... # your_access_key_secret

client = Client(endpoint, access_key_id, access_key_secret, human_readabel=True)

# You can enjoy Batchcompute through this `client` now!
...

2.1 create_job

参数说明：

返回值说明：

e.g.

try:
    # Init a Client object.
    client = ...

    # Refer to JobDescription class to have a look at how to create a new job description.
    job_desc = JobDescription(...)

    job = client.create_job(job_desc)
    # Print out the job id.
    print(job.JobId)
except ClientError, e:
    print(e)

（1）JobDescription 类

参数说明：

属性说明：

e.g.

• 可以通过赋值一一设置作业的描述信息。

from batchcompute import JobDescription, TaskDag, ResourceDescription

# Refer to TaskDag class to have a look at how to create a TaskDag.
task_dag = ... # A TaskDag object.

job_desc = JobDescription()
job_desc.JobName = 'find-prime'
job_desc.JobTag = 'Batchcompute'
job_desc.TaskDag = task_dag
job_desc.Description = 'Batchcompute Python SDK'
job_desc.Priority = 100

print(job_desc)

# You can create a new job with this description now!
...

• 也可以通过dict或者dict的JSON串批量设置作业的描述信息。

from batchcompute import Jobdescription, Taskdescription, TaskDag, ResourceDescription

job_json = '''{
    "JobName": "find-prime"
    "JobTag": "Batchcompute",
    "Priority": 0,
    "TaskDag": {
        "TaskDescMap": {
            "Find": {
                "PackageUri": "oss://your-bucket/batch_python_sdk/worker.tar.gz",
                "ProgramName": "find_prime_worker.py",
                "ProgramType": "python",
                "InstanceCount": 1,
                "ResourceDescription": {
                    "Cpu": 800,
                    "Memory": 2000
                },
                "EnvironmentVariables": {},
                "ImageId": "img-xxxx",
                "StdoutRedirectPath": "oss://your-bucket/batch_python_sdk/logs/",
                "StderrRedirectPath": "oss://your-bucket/batch_python_sdk/logs/"
            }
        },
        "Dependencies": {}
    }
}'''

job_desc = JobDescription(job_json)

print job_desc.JobName
print job_desc.JobTag
print job_desc.TaskDag
print job_desc.Description
print job_desc.Priority

print job_desc

（2） TaskDag类型

参数说明：

属性说明：

方法说明 ：

• 可以通过属性赋值的方式提供任务信息, 如下：

e.g.

# Refer to the TaskDescription class to have a look at how to create a new task.
find_task = ...

task_dag = TaskDag()
task_dag.TaskDescMap = {
    'Find': find_task
}
task_dag.Dependencies = {}

• 也可以通过类方法来增加任务信息，如下：

e.g.

# Refer to the TaskDescription class to have a look at how to create a new task.
find_task = ...

task_dag = TaskDag()
task_dag.add_task(task_name='Find', task=find_task)
task_dag.Dependencies = {}

（3） TaskDescription 类

参数说明：

属性说明：

e.g.

find_task = TaskDescription()
# Refer to the ResourceDescription class to have a look at how to create a resource description.
# Default set cpu needs to 800 and memory needs to 2000.
resource = ResourceDescription()

find_task.PackageUri = 'oss://your-bucket/batch-python-sdk/worker.tar.gz'
find_task.ProgramName = 'find_prime_worker.py'
find_task.ProgramType = 'python'
find_task.Priority = 0
find_task.ImageId = 'img-xxxx'
find_task.InstanceCount = 1
find_task.EnvironmentVariables = {}
find_task.StdoutRedirectPath = 'oss://your-bucket/batch-python-sdk/logs/'
find_task.StderrRedirectPath = 'oss://your-bucket/batch-python-sdk/logs/'
find_task.ResourceDescription = resource

# You can now add this task description to a TaskDag object through its add_task method.

（4） ResourceDescription 类

参数说明：

属性说明：

e.g.

resource = ResourceDescription()

resource.Cpu = 16
resource.Memory = 2000

# You can add this description to a task description now.
...

2.2 get_job_description

参数说明：

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    # Job ID.
    job = 'job-xxxx'
    # Get job description, it returns a GetResponse object.
    # You can use job_desc just like a JobDescription object.
    job_desc = client.get_job_description(job)
    print(job_desc.JobName, job_desc.TaskDag, job_desc.Priority)
except ClientError, e:
    print(e)

2.3 update_job_priority

参数说明：

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    # Job ID.
    job = 'job-xxxx'
    new_priority = 200
    # Get run-time infromation of the job.
    job_detail = client.get_job(job)
    if job_detail.State == 'Stopped':
        # Only the priority of a stopped job can be modified.
        client.update_job_priority(job, new_priority)
    job_detail = client.get_job(job)
    assert job_detail.Priority == new_priority
except ClientError, e:
    print(e)

2.4 stop_job

参数说明：

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    # Job ID.
    job = 'job-xxxx'
    job_detail = client.get_job(job)
    if job_detail.State in ['Waiting', 'Running']:
        # Only running or waiting jobs can be stopped.
        client.stop_job(job)
    job_detail = client.get_job(job)
    assert job_detail.State == 'Stopped'
except ClientError, e:
    print(e)

2.5 start_job

• 当 Failed 状态的作业重启之后，已经运行成功的 Instance 不会重新运行。

参数说明：

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    # Job ID.
    job = 'job-xxxx'
    job_detail = client.get_job(job)
    if job_detail.State == 'Stopped':
        # Only stopped job can be restarted.
        client.start_job(job)
    job_detail = client.get_job(job)
    assert job_detail.State in ['Waiting', 'Running']
except ClientError, e:
    print(e)

2.6 delete_job

参数说明：

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    # Job ID.
    job = 'job-xxxx'
    client.delete_job(job)
except ClientError, e:
    print(e)

2.7 get_job

参数说明：

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    job = 'job-xxxx'

    # Get job run-time information, it returns a GetResponse object.
    # You can use job_detail just like a Job object.
    job_detail = client.get_job(job)
    print(job_detail.State)
    ...
except ClientError, e:
    print(e)

（1） Job 类

参数说明：

属性说明：

2.8 list_jobs

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    # Get a list of all jobs owned by the user.
    job_list = client.list_job_status()
    for job_detail in job_list:
        print(job_detail.JobId, job_detail.State, job_detail.StartTime)
except ClientError, e:
    print(e)

2.9 list_tasks

参数说明：

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    # Job ID.
    job = 'job-xxxx'
    indent = ' '*4

    task_list = client.list_tasks(job)
    for task_detail in task_list:
        print(task_detail.TaskName, task_detail.State)
        for instance_detail in task.InstanceStatusList:
            print(instance_detail.InstanceId, instance_detail.State)
except ClientError, e:
    print(e)

（1） Task 类

参数说明：

属性说明：

（2） Instance 类

参数说明：

属性说明：

2.10 list_images

返回值说明：

e.g.

try:
    # Get a Client object.
    client = Client(...
    ...

    image_list = client.list_images()
    for image_detail in image_list:
        print(image_detail.ImageId, image_detail.ImageName)
except ClientError, e:
    print(e)

（1） Image 类

参数说明：

属性说明：