查询剧本拓扑关系
功能介绍
查询剧本拓扑关系
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/{instance_id}/topology
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:32 最大长度:36 |
workspace_id |
是 |
String |
工作空间ID 最小长度:32 最大长度:36 |
instance_id |
是 |
String |
剧本实例ID 最小长度:36 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
总数 最小值:0 最大值:99999 |
action_instances |
Array of ActionInstanceInfo objects |
流程实例列表 数组长度:0 - 100 |
参数 |
参数类型 |
描述 |
---|---|---|
action |
ActionInfo object |
剧本流程动作信息 |
instance_log |
AuditLogInfo object |
剧本实例审计日志信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
剧本流程动作ID 最小长度:32 最大长度:64 |
name |
String |
流程动作名称 最小长度:0 最大长度:1024 |
description |
String |
描述 最小长度:0 最大长度:1024 |
action_type |
String |
流程动作类型 最小长度:0 最大长度:64 |
action_id |
String |
流程ID 最小长度:32 最大长度:64 |
playbook_id |
String |
剧本ID 最小长度:0 最大长度:64 |
playbook_version_id |
String |
剧本版本ID 最小长度:0 最大长度:64 |
project_id |
String |
项目ID 最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
instance_type |
String |
实例类型(AOP_WORKFLOW--流程, SCRIPT--脚本, PLAYBOOK--剧本) 最小长度:0 最大长度:64 |
action_id |
String |
流程ID 最小长度:0 最大长度:1028 |
action_name |
String |
流程名称 最小长度:0 最大长度:64 |
instance_id |
String |
实例ID 最小长度:0 最大长度:1028 |
parent_instance_id |
String |
父节点实例ID 最小长度:0 最大长度:64 |
log_level |
String |
日志级别 最小长度:0 最大长度:1028 |
input |
String |
输入 最小长度:0 最大长度:64 |
output |
String |
输出 最小长度:0 最大长度:1028 |
error_msg |
String |
错误信息 最小长度:0 最大长度:64 |
start_time |
String |
开始时间 最小长度:0 最大长度:1028 |
end_time |
String |
结束时间 最小长度:0 最大长度:64 |
status |
String |
状态。(RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止) 最小长度:0 最大长度:1028 |
trigger_type |
String |
触发类型. TIMER--定时触发, EVENT--事件触发 最小长度:0 最大长度:1028 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
错误码 最小长度:0 最大长度:64 |
message |
String |
错误描述 最小长度:0 最大长度:1024 |
请求示例
无
响应示例
状态码: 200
请求成功响应信息
{ "count" : 41, "action_instances" : [ { "action" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "description" : "This my XXXX", "action_type" : "Workflow", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook_id" : "string", "playbook_version_id" : "string", "project_id" : "string" }, "instance_log" : { "instance_type" : "APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "action_name" : "DisabledIp", "instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "parent_instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "log_level" : "DEBUG INFO WARN", "input" : "input", "output" : "output", "error_msg" : "error_msg", "start_time" : "2021-01-30T23:00:00Z", "end_time" : "2021-01-31T23:00:00Z", "status" : "CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED", "trigger_type" : "DEBUG, TIMER, EVENT, MANUAL" } } ] }
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 |
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 ShowPlaybookTopologySolution { 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(); ShowPlaybookTopologyRequest request = new ShowPlaybookTopologyRequest(); try { ShowPlaybookTopologyResponse response = client.showPlaybookTopology(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 |
# 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 = ShowPlaybookTopologyRequest() response = client.show_playbook_topology(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 |
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.ShowPlaybookTopologyRequest{} response, err := client.ShowPlaybookTopology(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功响应信息 |
400 |
请求失败响应信息 |
错误码
请参见错误码。