更新时间:2024-10-22 GMT+08:00
分享

查询剧本实例列表

功能介绍

查询剧本实例列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:32

最大长度:36

workspace_id

String

工作空间ID

最小长度:32

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

status

String

剧本实例状态. (RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止)

最小长度:0

最大长度:64

name

String

实例名称

最小长度:0

最大长度:64

playbook_name

String

剧本名称

最小长度:0

最大长度:64

dataclass_name

String

数据类名称

最小长度:0

最大长度:64

dataobject_name

String

数据对象名称

最小长度:0

最大长度:64

trigger_type

String

触发类型. TIMER--定时触发, EVENT--事件触发

最小长度:0

最大长度:64

from_date

String

查询起始时间

最小长度:32

最大长度:36

to_date

String

查询结束时间

最小长度:32

最大长度:36

limit

Integer

分页查询参数,用于指定一次查询最多的结果数,从1开始

最小值:1

最大值:999999

offset

Integer

分页查询参数。用于指定查询结果的起始位置,从0开始

最小值:0

最大值:999999

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:2097152

content-type

String

application/json;charset=UTF-8

缺省值:application/json;charset=UTF-8

最小长度:1

最大长度:64

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表5 响应Body参数

参数

参数类型

描述

count

Integer

总数

最小值:0

最大值:99999

instances

Array of PlaybookInstanceInfo objects

剧本实例列表信息

数组长度:0 - 100

表6 PlaybookInstanceInfo

参数

参数类型

描述

id

String

剧本实例ID

最小长度:32

最大长度:64

name

String

剧本实例名称

最小长度:0

最大长度:1024

project_id

String

项目ID

最小长度:32

最大长度:64

playbook

PlaybookInfoRef object

剧本信息

dataclass

DataclassInfoRef object

数据类信息

dataobject

DataobjectInfo object

数据对象详情

status

String

剧本实例状态. (RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止)

最小长度:32

最大长度:64

trigger_type

String

触发类型. TIMER--定时触发, EVENT--事件触发

最小长度:0

最大长度:64

start_time

String

创建时间

最小长度:0

最大长度:64

end_time

String

更新时间

最小长度:0

最大长度:64

表7 PlaybookInfoRef

参数

参数类型

描述

id

String

剧本ID

最小长度:32

最大长度:64

version_id

String

剧本版本ID

最小长度:32

最大长度:64

name

String

名称

最小长度:32

最大长度:64

version

String

版本

最小长度:32

最大长度:64

表8 DataclassInfoRef

参数

参数类型

描述

id

String

数据类ID

最小长度:32

最大长度:64

name

String

数据类名称

最小长度:32

最大长度:64

表9 DataobjectInfo

参数

参数类型

描述

id

String

ID值

最小长度:32

最大长度:64

create_time

String

创建时间

最小长度:0

最大长度:64

update_time

String

更新时间

最小长度:0

最大长度:64

project_id

String

项目ID

最小长度:32

最大长度:64

dataclass_id

String

数据类ID

最小长度:32

最大长度:64

name

String

名称

最小长度:0

最大长度:1024

content

String

数据内容

最小长度:0

最大长度:4096

状态码: 400

表10 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表11 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:0

最大长度:64

message

String

错误描述

最小长度:0

最大长度:1024

请求示例

响应示例

状态码: 200

请求成功响应信息

{
  "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代码示例

SDK代码示例如下。

 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
49
50
51
52
53
54
55
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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ListPlaybookInstancesRequest request = new ListPlaybookInstancesRequest();
        request.withStatus("<status>");
        request.withName("<name>");
        request.withPlaybookName("<playbook_name>");
        request.withDataclassName("<dataclass_name>");
        request.withDataobjectName("<dataobject_name>");
        request.withTriggerType("<trigger_type>");
        request.withFromDate("<from_date>");
        request.withToDate("<to_date>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        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());
        }
    }
}
 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
# 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"]

    credentials = BasicCredentials(ak, sk)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListPlaybookInstancesRequest()
        request.status = "<status>"
        request.name = "<name>"
        request.playbook_name = "<playbook_name>"
        request.dataclass_name = "<dataclass_name>"
        request.dataobject_name = "<dataobject_name>"
        request.trigger_type = "<trigger_type>"
        request.from_date = "<from_date>"
        request.to_date = "<to_date>"
        request.limit = <limit>
        request.offset = <offset>
        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)
 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
49
50
51
52
53
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPlaybookInstancesRequest{}
	statusRequest:= "<status>"
	request.Status = &statusRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	playbookNameRequest:= "<playbook_name>"
	request.PlaybookName = &playbookNameRequest
	dataclassNameRequest:= "<dataclass_name>"
	request.DataclassName = &dataclassNameRequest
	dataobjectNameRequest:= "<dataobject_name>"
	request.DataobjectName = &dataobjectNameRequest
	triggerTypeRequest:= "<trigger_type>"
	request.TriggerType = &triggerTypeRequest
	fromDateRequest:= "<from_date>"
	request.FromDate = &fromDateRequest
	toDateRequest:= "<to_date>"
	request.ToDate = &toDateRequest
	request.Limit = int32(<limit>)
	request.Offset = int32(<offset>)
	response, err := client.ListPlaybookInstances(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功响应信息

400

请求失败响应信息

错误码

请参见错误码

相关文档