Querying Virtual Avatar Model Training Tasks

Function

Queries virtual avatar model training tasks.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

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. Value range: 0~2147483647 Default value: 0
limit	No	Integer	Number of items displayed on each page. Value range: 1~100 Default value: 10
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.
sort_key	No	String	Sorting field. Options: create_time: sorting by creation time update_time: sorting by update time asset_order: sorting by asset
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.
query_project_id	No	String	Queries the tenant ID.
update_since	No	String	Records whose update time is not earlier than the input time.
update_until	No	String	Records whose update time is not earlier than the input time.
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
is_flexus	No	Boolean	Whether the task is a Flexus task.
is_live_copy	No	Boolean	Whether it is a task for training a livestream-based avatar.
train_location	No	String	Training region.
is_ondemand_resource	No	Boolean	Whether it is a test version.

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. Value range: 0~2147483647
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. Mapping between these statuses and the statuses displayed on the MetaStudio console: To be submitted WAIT_FILE_UPLOAD: to upload files Auto reviewing... AUTO_VERIFYING: auto reviewing in progress MANUAL_VERIFYING: manually reviewing in progress Failed the auto review AUTO_VERIFY_FAILED: auto review failed MANUAL_VERIFY_FAILED: manual review failed Algorithm training ongoing MANUAL_VERIFY_SUCCESS: approved and waiting for resource preprocessing WAIT_TRAINING_DATA_PREPROCESS: waiting for training data preprocessing TRAINING_DATA_PREPROCESSING: training data being preprocessed 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: inference data being preprocessed INFERENCE_DATA_PREPROCESS_FAILED: inference data preprocessing failed WAIT_MAIN_FILE_UPLOAD: waiting for main file upload MANUAL_STOP_INFERENCE_DATA_PREPROCESS: inference preprocessing manually stopped MANUAL_STOP_TRAIN: training manually stopped MANUAL_STOP_TRAINING_DATA_PREPROCESS: training preprocessing manually stopped WAIT_ADMIN_CONFIRM: waiting for review by administrator WAIT_COMPILE: waiting for compilation COMPILING: compiling in progress COMPILE_FAILED: compilation failed WAIT_GENERATE_ACTION: waiting for generating an atomic action WAIT_ARRANGE: waiting for choreography ACTION_GENERATE_DATA_PROCESSING: an atomic action being generated MANUAL_STOP_ACTION_GENERATE_DATA_PROCESSING: action generation manually stopped MANUAL_STOP_ACTION_GENERATE_ORI_PROCESSING: choreography manually stopped ACTION_GENERATE_ORI_PROCESSING: choreographing in progress ACTION_GENERATE_DATA_FAILED: action generation failed ACTION_GENERATE_ORI_FAILED: generating the choreography asset failed ACTION_GENERATE_ORI_SUCCESS: choreography succeeded GENERATE_ACTION_PREPROCESS_FAILED: generating the atomic action for choreography failed WAIT_ADMIN_CALIBRATION: waiting for the administrator to confirm the action WAIT_ASSET_SYNC: waiting for asset synchronization WAIT_GENERATE_ACTION_MARK: waiting for generating an action mark ACTION_MARKING: action marking generated To be reviewed by users. This state is available only to whitelisted NAs. WAIT_USER_CONFIRM: waiting for the user to confirm the training result Rejected by users. This state is available only to whitelisted NAs. JOB_REJECT: task rejected Completed JOB_SUCCESS: training task completed. In this case, the model is available for the user. JOB_FINISH: task ended. This is the final state and cannot be changed. (This state is visible only for NA users, indicating that the model has been accepted by the user.) Suspended. This state is available only to whitelisted NAs. JOB_PENDING: task suspended WAIT_TEST_VIDEO_CHECK: waiting for test video inference TEST_VIDEO_CHECK_PROCESSING: testing video inference under quality check TEST_VIDEO_CHECK_SUCCESS: quality check on test video inference passed TEST_VIDEO_CHECK_FAILED: quality check on test video inference failed VIDEO_ANALYZE_PROCESSING: video check in progress VIDEO_ANALYZE_SUCCESS: video check passed VIDEO_ANALYZE_FAILED: video check failed ACTION_MARKING: action marking in progress ACTION_MARK_SUCCESS: action marking succeeded ACTION_MARK_FAILED: action marking failed ACTION_MARK_UPLOADED: action marking file uploaded MANUL_STOP_ACTION_MARK: action marking stopped NOTE: Tasks in this state need to be handled by the administrator. Users will see the status Algorithm training ongoing**.
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	Mobile number of the creator of the virtual avatar training task.
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 version is V3.2. V3.2: V3.2 model V3.3: training model for the ultra-fast Flexus edition NOTE: V3 and V2 have been deprecated. Value range: 0~64 Default value: V3.2
matting_type	String	Matting type. The default value is AI. AI: AI matting MANUAL: manual matting Default value: AI
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.
is_flexus	Boolean	Whether the image training is of the basic edition
is_live_copy	Boolean	Whether it is a task for training a livestream-based avatar.
is_fast_flexus	Boolean	Whether it is an ultra-fast Flexus edition. Default value: false
is_only_human_model	Boolean	Whether to train the image model but not the voice model. This parameter is valid only for Flexus. The default value is false. Default value: false
optional_training_location	Array of strings	Optional training region.
is_background_replacement	Boolean	Whether background replacement is required for a virtual avatar. If yes, training videos require green-screen shooting.
is_ondemand_resource	Boolean	Whether the task is on demand. Default value: false

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://example.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://example.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://example.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://example.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://example.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://example.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://example.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://example.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://example.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://example.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://example.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

Parameters error, including the error code and its description.

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

Status code: 500

Internal service error.

{
  "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.