Querying the List of Packages to Be Released
Function
This API is used to query the list of packages to be released.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/factory/pending-items
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Project ID and Account ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
submit_user_name |
No |
String |
Committer. |
item_name |
No |
String |
Task name. |
update_type |
No |
String |
Operation type. |
task_type |
No |
String |
Job type. |
start_time |
No |
String |
Start time |
end_time |
No |
String |
End time |
limit |
No |
Integer |
The maximum number of records on each page. Value range: 1 to 100 Default value: 10 |
offset |
No |
Integer |
Number of pages in the list. The default value is 0. The value must be greater than or equal to 0. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
X-Auth-Token |
No |
String |
IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory when token authentication is used. The value contains 0 to 4096 characters. |
X-Project-Id |
No |
String |
project_id: project ID. For details about how to obtain the project ID and account ID, see Project ID and Account ID. This field is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
Array of data objects |
Information about the package to be released |
total |
Integer |
Number of Packages to Be Released |
Parameter |
Type |
Description |
---|---|---|
deployed_version |
Integer |
Released Node Version |
item_name |
String |
Task Name |
package_flag |
Integer |
Packing status. The value 0 indicates that the package is not packed. |
pending_item_id |
String |
ID of the package to be released |
pending_version |
Integer |
Version of the package to be released |
project_id |
String |
Tenant ID + Space ID |
submit_timestamp |
Long |
Commit time. |
submit_user_id |
String |
Submitter ID |
submit_user_name |
String |
Committer name. |
task_id |
String |
Task ID |
task_type |
Integer |
Task type. The value can be 1 or 2. 1: job 2: script |
update_type |
Integer |
Change type. The value can be 1, 2, or 3. 1: new 2: change 3: delete |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
Query the list of packages to be released.
GET /v2/62099355b894428e8916573ae635f1f9/factory/pending-items
Example Responses
Status code: 200
The list of packages to be released is returned.
{ "data" : [ { "deployed_version" : 0, "item_name" : "job_0242", "package_flag" : 0, "pending_item_id" : "4", "pending_version" : 1, "project_id" : "62099355b894428e8916573ae635f1f9-workspace-e265f808151d458bb7967e0aaf42d146", "submit_timestamp" : 1747106103570, "submit_user_id" : "f8ccc2ff3c7748e8a7bfede38ae1cffa", "submit_user_name" : "fengqijie", "task_id" : "451", "task_type" : 1, "update_type" : 1 }, { "deployed_version" : 0, "item_name" : "job_0994", "package_flag" : 0, "pending_item_id" : "3", "pending_version" : 1, "project_id" : "62099355b894428e8916573ae635f1f9-workspace-e265f808151d458bb7967e0aaf42d146", "submit_timestamp" : 1747106092403, "submit_user_id" : "f8ccc2ff3c7748e8a7bfede38ae1cffa", "submit_user_name" : "fengqijie", "task_id" : "450", "task_type" : 1, "update_type" : 1 } ], "total" : 2 }
Status code: 400
Failure. Return information.
{ "error_code" : "DLF.3051", "error_msg" : "The request parameter is invalid." }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListFactoryPendingItemsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ListFactoryPendingItemsRequest request = new ListFactoryPendingItemsRequest(); try { ListFactoryPendingItemsResponse response = client.listFactoryPendingItems(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListFactoryPendingItemsRequest() response = client.list_factory_pending_items(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListFactoryPendingItemsRequest{} response, err := client.ListFactoryPendingItems(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The list of packages to be released is returned. |
400 |
Failure. Return information. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot