Query image generation progress - sd_get_progress-Intelligent Education Platform(IEP)-阿里云帮助中心

API description

Querying graph generation progress

Prerequisites

You have integrated the ApsaraVideo for Media Processing software development kit (SDK). For more information, see SDK Reference for earlier versions.

Authorization

This API uses an AccessKey pair (AK/SK) for authorization. For more information about how to obtain an AccessKey pair, see API authorization.

Endpoint

https://openai.edu-aliyun.com

Request path

/scc/sd_get_progress

Request parameters

Body

Name		Type	Required	Description
taskId		string	Required	The task ID returned after you submit an image generation task.

Response parameters

Data

Name		Type	Description
status		string	The status of the image generation task. This is an enumeration. waiting: The task is in the queue. running: The image is being generated. failed: The image generation failed. successed: The image was generated successfully.
progress		double	The progress of image generation. The value ranges from 0 to 1.
lastQueueRemaining		integer	The length of the waiting queue. This parameter is valid only when `status` is `waiting`.
etaRelative		double	The estimated remaining time for image generation, in seconds.
message		string	A brief description of the image generation progress.
state		object	The detailed progress of image generation (native sd parameters).
	job	string	The current job being executed.
	job_no	integer	The ordinal number of the current job.
	job_count	integer	The number of iteration steps for the current node.
	job_timestamp	integer	The maximum number of iteration steps for the current node.
	sampling_step	integer	The current iteration step.
	sampling_steps	integer	The total number of iteration steps.
	skipped	bool	Skip
	interrupted	bool	Indicates whether the job was interrupted.

Examples

Example 1: In queue

{
    "status": 10,
    "apiInvokeId": "i_66c5ad0babc5ab0023d2e1f6",
    "data": {
        "etaRelative": 0,
        "lastQueueRemaining": 1,
        "progress": 0,
        "taskId": "01j5t2qx82323pswaqykz9eq4",
        "status": "waiting"
    },
    "subErrCode": null,
    "subErrMessage": null,
    "errCode": null,
    "errMessage": null,
    "startTime": null,
    "endTime": null
}

Error codes

None.