Querying the Playbook Instance List
Function
This API is used to query the playbook instance list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
workspace_id |
Yes |
String |
Workspace ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
status |
No |
String |
Playbook instance status. (RUNNING: Running; FINISHED: Successful; FAILED: Failed; RETRYING: Retrying; TERMINATING: Terminating; TERMINATED: Terminated) |
name |
No |
String |
Instance name. |
playbook_name |
No |
String |
Playbook name. |
dataclass_name |
No |
String |
Data class name. |
dataobject_name |
No |
String |
Data object name. |
trigger_type |
No |
String |
Trigger type. TIMER: The playbook is triggered at a scheduled time; EVENT: The playbook is triggered by an event. |
from_date |
No |
String |
Start time for the query. |
to_date |
No |
String |
End time for the query. |
limit |
Yes |
Integer |
The maximum number of records can be returned on each page for a pagination query. The value starts from 1. |
offset |
Yes |
Integer |
Pagination query parameter. This parameter specifies the start position of the query result. The value starts from 0. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
content-type |
Yes |
String |
application/json;charset=UTF-8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number. |
instances |
Array of PlaybookInstanceInfo objects |
Playbook instance list information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Playbook instance ID. |
name |
String |
Playbook instance name. |
project_id |
String |
Project ID. |
playbook |
PlaybookInfoRef object |
Playbook information. |
dataclass |
DataclassInfoRef object |
Data class information. |
dataobject |
DataobjectInfo object |
Data object details. |
status |
String |
Playbook instance status. (RUNNING: Running; FINISHED: Successful; FAILED: Failed; RETRYING: Retrying; TERMINATING: Terminating; TERMINATED: Terminated) |
trigger_type |
String |
Trigger type. TIMER: The playbook is triggered at a scheduled time; EVENT: The playbook is triggered by an event. |
start_time |
String |
Creation time. |
end_time |
String |
Update time. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Playbook ID. |
version_id |
String |
Playbook version ID. |
name |
String |
Name. |
version |
String |
Version. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Data class ID. |
name |
String |
Data class name. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID. |
create_time |
String |
Creation time. |
update_time |
String |
Update time. |
project_id |
String |
Project ID. |
dataclass_id |
String |
Data class ID. |
name |
String |
Name. |
content |
String |
Data content. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code. |
message |
String |
Error description. |
Example Requests
None
Example Responses
Status code: 200
Response to a successful request.
{ "count" : 41, "instances" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version" : "v1.1.1" }, "dataclass" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "dataobject" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "status" : "TERMINATED", "trigger_type" : "string", "start_time" : "2021-01-30T23:00:00Z+0800", "end_time" : "2021-01-30T23:00:00Z+0800" } ] }
SDK Sample Code
The SDK sample code is as follows.
Java
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 48 |
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.secmaster.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.model.*; public class ListPlaybookInstancesSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); ListPlaybookInstancesRequest request = new ListPlaybookInstancesRequest(); request.withWorkspaceId("{workspace_id}"); try { ListPlaybookInstancesResponse response = client.listPlaybookInstances(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()); } } } |
Python
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPlaybookInstancesRequest() request.workspace_id = "{workspace_id}" response = client.list_playbook_instances(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/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 := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPlaybookInstancesRequest{} request.WorkspaceId = "{workspace_id}" response, err := client.ListPlaybookInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
Response to a successful request. |
400 |
Response message for failed requests. |
Error Codes
See Error Codes.
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