新建操作连接 - CreateConnection
功能介绍
新建操作连接
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/assetcredentials
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间ID 取值范围: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
操作连接的名称 |
|
description |
否 |
String |
操作连接的描述信息 |
|
component_id |
是 |
String |
操作连接所属的插件id |
|
component_version_id |
是 |
String |
操作连接所属的插件版本id |
|
config |
是 |
String |
具体的操作连接配置字符串,根据插件的操作连接schema配置对应字段值 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误信息 |
|
asset |
AssetInfoResponseBody object |
操作连接信息参数对象 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
操作连接ID |
|
project_id |
String |
项目ID |
|
workspace_id |
String |
空间ID |
|
name |
String |
操作连接名称 |
|
component_id |
String |
操作连接所属的插件id |
|
component_name |
String |
操作连接所属的插件id名称 |
|
component_version_id |
String |
插件版本ID |
|
type |
String |
操作连接类型 |
|
status |
String |
操作连接状态(SUCCESS/FAILED) |
|
config |
String |
具体的操作连接配置字符串,根据插件的操作连接schema配置对应字段值 |
|
description |
String |
操作连接描述 |
|
enabled |
Boolean |
是否启用 |
|
create_time |
String |
创建时间 |
|
creator_id |
String |
创建者ID |
|
creator_name |
String |
创建者名称 |
|
update_time |
String |
更新时间 |
|
modifier_id |
String |
更新者ID |
|
modifier_name |
String |
更新者名称 |
|
defense_type |
String |
下发应急策略时的所属的防线分类 |
|
target_project_id |
String |
下发应急策略时的IAM项目ID |
|
target_project_name |
String |
下发应急策略时的IAM项目名称 |
|
target_enterprise_id |
String |
下发应急策略时的企业项目ID |
|
target_enterprise_name |
String |
下发应急策略时的企业项目名称 |
|
region_id |
String |
下发应急策略时的区域ID |
|
region_name |
String |
下发应急策略时的区域名称 |
|
can_be_deleted |
Boolean |
是否可删除,操作连接有流程在使用时,返回false |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
在某个工作空间创建一个操作连接的请求样例
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/assetcredentials
{
"name" : "demo_create",
"description" : "demo_description",
"component_id" : "ad93ecc6-1723-4c2c-9976-9eb0182c2d18",
"component_version_id" : "33fd1b37-1f39-4230-86c6-2d119e9f4fac",
"config" : "{\"password\":\"******\",\"kafkaAddr\":\"aaa\",\"keyStorePassword\":\"******\",\"userName\":\"bbb\"}"
}
响应示例
状态码:200
请求成功
{
"code" : "00000000",
"message" : "",
"asset" : {
"id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
"project_id" : "4185bbd2-9d18-4362-92cb-46df0b24fe4e",
"workspace_id" : "ce7bed87-a3eb-4ff9-8bd0-b23ab3ef7b19",
"name" : "demo_create",
"component_id" : "ad93ecc6-1723-4c2c-9976-9eb0182c2d18",
"component_name" : "KafkaPlugIn",
"component_version_id" : "33fd1b37-1f39-4230-86c6-2d119e9f4fac",
"type" : "datasource",
"status" : "success",
"config" : "{\"password\":\"******\",\"kafkaAddr\":\"aaa\",\"keyStorePassword\":\"******\",\"userName\":\"bbb\"}",
"description" : "demo_description",
"enabled" : true,
"create_time" : "2022-06-16T10:37:50Z+0800",
"creator_id" : "demo_user",
"creator_name" : "demo_user",
"update_time" : "2022-06-16T10:37:50Z+0800",
"modifier_id" : "demo_user,",
"modifier_name" : "demo_user",
"defense_type" : "CFW",
"target_project_id" : "0996e7468d80f2672fa5c01432f1550b",
"target_project_name" : "demo_project",
"target_enterprise_id" : "0,",
"target_enterprise_name" : "default",
"region_id" : "demo_region",
"region_name" : "demo_region",
"can_be_deleted" : true
}
}
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.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class CreateConnectionSolution { 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(); CreateConnectionRequest request = new CreateConnectionRequest(); request.withWorkspaceId("{workspace_id}"); CreateAssetsRequestBody body = new CreateAssetsRequestBody(); body.withConfig("{"password":"******","kafkaAddr":"aaa","keyStorePassword":"******","userName":"bbb"}"); body.withComponentVersionId("33fd1b37-1f39-4230-86c6-2d119e9f4fac"); body.withComponentId("ad93ecc6-1723-4c2c-9976-9eb0182c2d18"); body.withDescription("demo_description"); body.withName("demo_create"); request.withBody(body); try { CreateConnectionResponse response = client.createConnection(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 |
# 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 = CreateConnectionRequest() request.workspace_id = "{workspace_id}" request.body = CreateAssetsRequestBody( config="{"password":"******","kafkaAddr":"aaa","keyStorePassword":"******","userName":"bbb"}", component_version_id="33fd1b37-1f39-4230-86c6-2d119e9f4fac", component_id="ad93ecc6-1723-4c2c-9976-9eb0182c2d18", description="demo_description", name="demo_create" ) response = client.create_connection(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 |
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.CreateConnectionRequest{} request.WorkspaceId = "{workspace_id}" descriptionCreateAssetsRequestBody:= "demo_description" request.Body = &model.CreateAssetsRequestBody{ Config: "{"password":"******","kafkaAddr":"aaa","keyStorePassword":"******","userName":"bbb"}", ComponentVersionId: "33fd1b37-1f39-4230-86c6-2d119e9f4fac", ComponentId: "ad93ecc6-1723-4c2c-9976-9eb0182c2d18", Description: &descriptionCreateAssetsRequestBody, Name: "demo_create", } response, err := client.CreateConnection(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求参数有误 |
|
500 |
请求失败 |
错误码
请参见错误码。