PersonalizedTextToImageQueryPreModelInferenceJobInfo-Smart Science and Education Content Platform(SSECP)-阿里云帮助中心

Queries the status of a personalized text-to-image inference job.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aicontent:PersonalizedTextToImageQueryPreModelInferenceJobInfo

get

*All Resource

*

None

Request syntax

GET /api/v1/personalizedtxt2img/queryPreModelInferenceJobInfo HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
inferenceJobId	string	Yes	The inference job ID.	girl-xxxx-xxxx-xxxx-xxxx

Response elements

Element	Type	Description	Example
	object	OpenApiSingleResponse	{"data":{"jobStatus":"WAIT_SCHEDULE","modelId":"girl_6dcc62b4-4019-11ef-a7fd-954b0578482b","createTime":"2024-07-12T14:44:19.362931","promptId":"2a3d91c0-401a-11ef-a7fd-954b0578482b","id":"20"},"success":true,"errCode":null,"errMessage":null,"requestId":"048F9250-03AD-19F3-B07D-D2879CF34AF1"}
requestId	string	The request ID.	xxxx-xxxx-xxxx-xxxxxxxx
success	boolean	Indicates whether the request was successful.	true
errCode	string	The error code.	UNKNOWN_ERROR
errMessage	string	The error message.	未知错误
httpStatusCode	integer	The HTTP status code.	200
data	object	The response data object.	[]
id	string	The inference job ID.	3220
promptId	string	The ID of the prompt used for the job.	promptId-xxxx-xxxx-xxxx
modelId	string	The model ID.	modelId-xxxx-xxxx-xxxx
jobStatus	string	The job status.	FINISHED
jobTrainProgress	number	The job progress.	0.5
resultImageUrl	array	A list of resource IDs for the generated images.	0000.png
	string	The resource ID of a generated image.	0000.png
createTime	string	The creation time of the inference job.	2023-12-25T12:00:00

Examples

Success response

JSON format

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": {
    "id": "3220",
    "promptId": "promptId-xxxx-xxxx-xxxx",
    "modelId": "modelId-xxxx-xxxx-xxxx",
    "jobStatus": "FINISHED",
    "jobTrainProgress": 0.5,
    "resultImageUrl": [
      "0000.png"
    ],
    "createTime": "2023-12-25T12:00:00"
  }
}

Error codes

HTTP status code	Error code	Error message
400	B_PARAMETER_NOT_FOUND_EXCEPTION	必要参数没有找到
500	UNKNOWN_ERROR	The request processing has failed due to some unknown error.
403	B_PERMISSION_DENIED_EXCEPTION	鉴权失败或权限不足
404	B_DATA_NOT_FOUND_EXCEPTION	资源没有找到

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.