本接口支持获取文生图异步任务生成的结果图地址。
本段主要介绍如何获取调用时的参数信息,以及获取后在本接口的具体传参位置。
ServiceId。ModelAction、ModelVersion 和 ReqJson 这个三个参数的填写。下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetCVImageGenerateTask | 接口名称。当前 API 的名称为 GetCVImageGenerateTask。 |
| Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01。 |
| ServiceId | String | 是 | serviceid | 指定要查询的服务 ID。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| TaskId | String | 是 | 7418048504813240370 | 指定文生图异步任务的任务 ID。 |
| ModelAction | String | 是 | CVSync2AsyncSubmitTask | 查询通用2.0-文生图异步任务模型接口的 Action 名称,即 CVSync2AsyncGetResult。 |
| ModelVersion | String | 是 | 2022-08-31 | 查询通用2.0-文生图异步任务模型接口的 Version 名称,即 2022-08-31。 |
ReqJson | JSON Map | 是 |
| 查询通用2.0-文生图异步任务模型接口的请求 JSON 字符串。
说明 您可忽略 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Status | String |
| 任务状态,取值如下所示:
|
| TaskId | String | 7418048504813240370 | 任务 ID |
| ImageUrls | Array of String | ["http://test.example.cn/demo1~tplv-serviceid-image.image"] | 最终上传至 veImageX 服务的结果图访问 URL,数量为 1。 |
RespJson | JSON Map |
| 根据查询通用2.0-文生图异步任务模型接口信息,接收的该接口响应的 JSON 数据。 |
| StoreUris | Array of String | ["tos-cn-i-serviceid/demo1"] | 结果图存储 URI,数量为 1。 |
POST https://imagex.volcengineapi.com/?Action=GetCVImageGenerateTask&Version=2023-05-01&ServiceId=serviceid { "TaskId": "7418048504813240370", "ReqJson": { "req_key": "high_aes_general_v20_L", "task_id": "7418049665255653414" }, "ModelAction": "CVSync2AsyncSubmitTask", "ModelVersion": "2022-08-31" }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetCVImageGenerateTask", "Version": "2023-05-01", "Service": "ImageX", "Region": "cn-north-1" }, "Result": { "Status": "done", "ImageUrls": [ "http://test.example.cn/demo1~tplv-serviceid-image.image" ], "RespJson": { "code": 10000, "data": { "binary_data_base64": null, "image_urls": [ "https://xxxx" ], "status": "done" }, "message": "Success", "request_id": "2025061718460554C9B78D23B0BAB45B2A", "time_elapsed": "508.312154ms" }, "TaskId": "7418048504813240370", "StoreUris": [ "tos-cn-i-serviceid/demo1" ] } }
本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。
veImageX 提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。