Querying Virtual Avatar Model Training Tasks

Function

Queries virtual avatar model training tasks.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/digital-human-training-manage/user/jobs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset where the query starts.
limit	No	Integer	Number of items displayed on each page.
sort_key	No	String	Sorting field. Currently, only create_time is supported.
sort_dir	No	String	Sorting mode. asc: ascending order desc: descending order asc is used by default.
create_until	No	String	Filter the records whose creation time is not later than the entered time.
create_since	No	String	Filter the records whose creation time is not earlier than the entered time.
state	No	String	Task status. By default, all statuses are selected. Multiple statuses can be queried. Use commas (,) to separate them, for example, state=CREATING,PUBLISHED.
query_project_id	No	String	Queries the tenant ID.
batch_name	No	String	Task batch name.
tag	No	String	Task tag.
job_id	No	String	Task ID.
name	No	String	Virtual avatar model name.
model_resolution	No	String	Model resolution

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.
X-App-UserId	No	String	Third-party user ID, which does not allow Chinese characters.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 5** Response body parameters
Parameter	Type	Description
count	Integer	Number of virtual avatar model training tasks.
jobs	Array of TrainingJobBasicInfo objects	Virtual avatar model training tasks.

**Table 6** TrainingJobBasicInfo
Parameter	Type	Description
job_id	String	Task ID.
name	String	Virtual avatar model name, which is used as its name in the asset library.
state	String	Task status. Options: WAIT_FILE_UPLOAD: To upload files. AUTO_VERIFYING: Auto reviewing. AUTO_VERIFY_FAILED: Auto review failed. MANUAL_VERIFYING: Manually reviewing. MANUAL_VERIFY_FAILED: Manual review failed. MANUAL_VERIFY_SUCCESS: Approved and waiting for resource preprocessing. TRAINING_DATA_PREPROCESSING: Preprocessing training data. TRAINING_DATA_PREPROCESS_FAILED: Training data preprocessing failed. TRAINING_DATA_PREPROCESS_SUCCESS: Training data preprocessed and waiting for resource training. TRAINING: Training. TRAIN_FAILED: Training failed. TRAIN_SUCCESS: Training completed and waiting for resource preprocessing. INFERENCE_DATA_PREPROCESSING: Preprocessing inference data. INFERENCE_DATA_PREPROCESS_FAILED: Inference data preprocessing failed. WAIT_MAIN_FILE_UPLOAD: Waiting for main file upload. JOB_SUCCESS: Training succeeded. WAIT_USER_CONFIRM: Waiting for users to confirm the training result. JOB_REJECT: Training rejected. JOB_PENDING: Training pending. JOB_FINISH: Training finished and cannot be changed.
asset_id	String	Model asset ID.
project_id	String	Project ID of a model asset.
cover_download_url	String	URL for downloading the virtual avatar model thumbnail. The URL is valid for 24 hours.
last_update_time	String	Indicates the last time when a user updates a task (for example, creates or resubmits a task). The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.
create_time	String	Creation time. The format complies with RFC 3339, for example, 2020-07-30T10:43:17Z.
contact	String	Contact of the virtual avatar training task creator, for example, mobile number or email address.
batch_name	String	Batch name of virtual avatar training tasks.
tags	Array of strings	Tag of a virtual avatar training task.
model_version	String	Virtual avatar model version. The default value is V3. V2: V2 model V3: V3 model
matting_type	String	Matting type. The default value is AI. AI: AI matting MANUAL: manual matting
model_resolution	String	Virtual avatar model resolution, which defaults to 1080p. 1080P: 1080p. 1080p or 720p video output is supported. 4K: 4K. 4K, 1080p, or 720p video output is supported.
app_user_id	String	Customized user ID. This parameter is carried if X-App-UserId is set during task creation.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

https://aaa.com/rest/v1/***/digital-human-training-manage/user/jobs?query_project_id=***&offset=0&limit=10

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "count" : 101,
  "jobs" : [ {
    "job_id" : "646682facddb4912976f19a4d61c6a91",
    "name" : "Name 1",
    "state" : "TRAINING",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/646682facddb4912976f19a4d61c6a91_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-09T07:38:09Z",
    "create_time" : "2023-12-08T08:30:56Z",
    "contact" : "1**********",
    "tags" : [ ],
    "model_version" : "V3.2",
    "matting_type" : "AI"
  }, {
    "job_id" : "efc5300ecdba4ea48d1ff13a9d907bc0",
    "name" : "Name 2",
    "state" : "MANUAL_VERIFYING",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/efc5300ecdba4ea48d1ff13a9d907bc0_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-09T07:32:46Z",
    "create_time" : "2023-12-09T07:31:37Z",
    "contact" : "1**********",
    "model_version" : "V3",
    "matting_type" : "AI"
  }, {
    "job_id" : "7889dfd55bf14834a35e78c7f0aa0516",
    "name" : "Name 3",
    "state" : "INFERENCE_DATA_PREPROCESS_FAILED",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/7889dfd55bf14834a35e78c7f0aa0516_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-09T07:09:02Z",
    "create_time" : "2023-12-08T08:34:12Z",
    "contact" : "1**********",
    "tags" : [ ],
    "model_version" : "V3.2",
    "matting_type" : "AI"
  }, {
    "job_id" : "222509ed63c2498599f519d5ec7ef462",
    "name" : "Name 4",
    "state" : "TRAINING_DATA_PREPROCESS_SUCCESS",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/222509ed63c2498599f519d5ec7ef462_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-09T07:08:21Z",
    "create_time" : "2023-12-08T08:33:24Z",
    "contact" : "1**********",
    "tags" : [ ],
    "model_version" : "V3.2",
    "matting_type" : "AI"
  }, {
    "job_id" : "dd4a596edc2c44dd881b5e9eff485e21",
    "name" : "Name 5",
    "state" : "TRAINING_DATA_PREPROCESS_SUCCESS",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/dd4a596edc2c44dd881b5e9eff485e21_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-09T02:12:01Z",
    "create_time" : "2023-12-08T08:29:25Z",
    "contact" : "1**********",
    "model_version" : "V3.2",
    "matting_type" : "AI"
  }, {
    "job_id" : "bf46c9f335b14e84bd028f6acb52686b",
    "name" : "Name 6",
    "state" : "JOB_FINISH",
    "asset_id" : "3174263c6199e0a10d83a257b272ac71",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/bf46c9f335b14e84bd028f6acb52686b_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-08T08:37:39Z",
    "create_time" : "2023-11-29T09:39:25Z",
    "contact" : "1**********",
    "model_version" : "V3",
    "matting_type" : "AI"
  }, {
    "job_id" : "2f96ddd4fdda40af977c1b1d3b6adca8",
    "name" : "Name 7",
    "state" : "INFERENCE_DATA_PREPROCESS_FAILED",
    "asset_id" : "22741ee4bc4130282835bdc2a4b4ac79",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/2f96ddd4fdda40af977c1b1d3b6adca8_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-08T07:26:53Z",
    "create_time" : "2023-10-19T01:13:24Z",
    "contact" : "15312090046",
    "batch_name" : "234",
    "model_version" : "V3",
    "matting_type" : "AI"
  }, {
    "job_id" : "e477dcf363234b2f8aa2aad4d8bad46b",
    "name" : "Name 8",
    "state" : "INFERENCE_DATA_PREPROCESS_FAILED",
    "asset_id" : "d36e8df774ae88315911724d4467cb6d",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/e477dcf363234b2f8aa2aad4d8bad46b_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-08T01:58:52Z",
    "create_time" : "2023-11-27T06:39:46Z",
    "contact" : "1**********",
    "model_version" : "V3.2",
    "matting_type" : "AI"
  }, {
    "job_id" : "d8ca20175d5b4ae6b0056c62e4553d36",
    "name" : "Name 9",
    "state" : "INFERENCE_DATA_PREPROCESS_FAILED",
    "asset_id" : "5ff8e2893ffa8ef848050260eb08faa9",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/d8ca20175d5b4ae6b0056c62e4553d36_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-04T05:39:24Z",
    "create_time" : "2023-11-06T13:51:09Z",
    "contact" : "1**********",
    "model_version" : "V3.2",
    "matting_type" : "AI"
  }, {
    "job_id" : "65e9fb9ac78546268e7d60d5003bfbdc",
    "name" : "Name 10",
    "state" : "INFERENCE_DATA_PREPROCESS_FAILED",
    "asset_id" : "71a0df4bd5966a33818af2b5094cf197",
    "project_id" : "***",
    "cover_download_url" : "https://xxx.com/65e9fb9ac78546268e7d60d5003bfbdc_cover?param1=XXX&param2=YYY",
    "last_update_time" : "2023-12-01T07:58:26Z",
    "create_time" : "2023-11-29T11:19:22Z",
    "contact" : "1**********",
    "model_version" : "V3",
    "matting_type" : "AI"
  } ]
}

Status code: 400

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status code: 500

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code	Description
200	The information is returned when the request succeeded.
400	Parameters error, including the error code and its description.
500	Internal service error.