Creating an Operation Connection

Function

This API is used to create an operation connection.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/assetcredentials

**Table 1** Path Parameters
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

**Table 2** Request header 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. application/json;charset=UTF-8: common API request type Constraints N/A Range application/json;charset=UTF-8 Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Operation connection name.
description	No	String	Description of the operation connection.
component_id	Yes	String	ID of the plugin to which the operation connection belongs.
component_version_id	Yes	String	ID of the plugin version to which the operation connection belongs.
config	Yes	String	Configuration string of the operation connection. Configure the field value based on the plugin operation connection schema.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Error code.
message	String	Error message.
asset	AssetInfoResponseBody object	Operation connection information parameter object.

**Table 5** AssetInfoResponseBody
Parameter	Type	Description
id	String	Operation connection ID.
project_id	String	Project ID.
workspace_id	String	Workspace ID.
name	String	Operation connection name.
component_id	String	ID of the plugin to which the operation connection belongs.
component_name	String	Name of the plugin ID to which the operation connection belongs.
component_version_id	String	Plugin version ID.
type	String	Operation connection type.
status	String	Operation connection status (SUCCESS or FAILED)
config	String	Configuration string of the operation connection. Configure the field value based on the plugin operation connection schema.
description	String	Operation connection description.
enabled	Boolean	Whether to enable this feature.
create_time	String	Creation time.
creator_id	String	Creator ID.
creator_name	String	Creator name.
update_time	String	Update time.
modifier_id	String	Updater ID.
modifier_name	String	Updater name.
defense_type	String	Defense layer for the emergency policy.
target_project_id	String	IAM project ID for the emergency policy.
target_project_name	String	IAM project name for the emergency policy.
target_enterprise_id	String	Enterprise project ID for the emergency policy.
target_enterprise_name	String	Enterprise project name for the emergency policy.
region_id	String	Region ID for the emergency policy.
region_name	String	Region name for the emergency policy.
can_be_deleted	Boolean	Whether the connection can be deleted. If the connection is used by a workflow, false is returned.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

Example Requests

description

{
  "name" : "test_create",
  "description" : "description",
  "component_id" : "ad93ecc6-1723-4c2c-9976-9eb0182c2d18",
  "component_version_id" : "33fd1b37-1f39-4230-86c6-2d119e9f4fac",
  "config" : "{\"password\":\"******\",\"kafkaAddr\":\"aaa\",\"keyStorePassword\":\"******\",\"userName\":\"bbb\"}"
}