Creating a Plugin Configuration Template
Function
This API is used to create a plugin configuration template during workflow configuration.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/components/template
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
|
workspace_id |
Yes |
String |
Definition Workspace ID. Range N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A |
|
content-type |
Yes |
String |
Definition Content type. Constraints N/A Range Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
component_id |
Yes |
String |
Plugin ID. |
|
template_name |
Yes |
String |
Plugin template name. |
|
task_config |
Yes |
String |
Plugin action configuration content. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
message |
String |
Error message. |
|
success |
Boolean |
Request status. |
|
request_id |
String |
Request ID. |
|
data |
TemplateInfo object |
Plugin configuration template information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Template ID. |
|
component_id |
String |
Plugin ID. |
|
template_name |
String |
Name of the plugin configuration template. |
|
task_config |
String |
Plugin action configuration content. |
|
create_time |
String |
Creation time. |
|
update_time |
String |
Update time. |
|
project_id |
String |
Project ID. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Create a plug-in configuration template named demo_template.
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/components/template
{
"component_id" : "ad93ecc6-1723-4c2c-9976-9eb0182c2d18",
"template_name" : "demo_template",
"task_config" : "{\"action\":\"queryEs\",\"input\":{}}"
}
Example Responses
Status code: 200
Object returned upon a successful response.
{
"code" : "00000000",
"message" : "message",
"success" : true,
"request_id" : "xxxxxx",
"data" : {
"id" : "5d4157f4-4811-430c-9d69-25f3137cbc80",
"component_id" : "ad93ecc6-1723-4c2c-9976-9eb0182c2d18",
"template_name" : "demo_template",
"task_config" : "{\"action\":\"queryEs\",\"input\":{}}",
"create_time" : "2025-08-26T18:53:27.566Z+0800",
"update_time" : "2025-08-26T18:53:27.566Z+0800",
"project_id" : "15645222e8744afa985c93dab6341da6"
}
}
SDK Sample Code
The SDK sample code is as follows.
Create a plug-in configuration template named demo_template.
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 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.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class CreateComponentTemplateSolution { 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(); CreateComponentTemplateRequest request = new CreateComponentTemplateRequest(); request.withWorkspaceId("{workspace_id}"); CreateTemplateReq body = new CreateTemplateReq(); body.withTaskConfig("{"action":"queryEs","input":{}}"); body.withTemplateName("demo_template"); body.withComponentId("ad93ecc6-1723-4c2c-9976-9eb0182c2d18"); request.withBody(body); try { CreateComponentTemplateResponse response = client.createComponentTemplate(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()); } } } |
Create a plug-in configuration template named demo_template.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateComponentTemplateRequest() request.workspace_id = "{workspace_id}" request.body = CreateTemplateReq( task_config="{"action":"queryEs","input":{}}", template_name="demo_template", component_id="ad93ecc6-1723-4c2c-9976-9eb0182c2d18" ) response = client.create_component_template(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create a plug-in configuration template named demo_template.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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 := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateComponentTemplateRequest{} request.WorkspaceId = "{workspace_id}" request.Body = &model.CreateTemplateReq{ TaskConfig: "{"action":"queryEs","input":{}}", TemplateName: "demo_template", ComponentId: "ad93ecc6-1723-4c2c-9976-9eb0182c2d18", } response, err := client.CreateComponentTemplate(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 |
Object returned upon a successful response. |
|
400 |
Object returned upon a response error. |
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