GCP Connector Actions

Describe a connector action

get/gcpconnectors/{gcpConnectorID}/actions/{actionID}

Describe a connector action by connector ID and action ID.

Related SDK Methods:
Java

GcpConnectorActionsApi.describeGCPConnectorAction([param1, param2, ...])

Python

GCPConnectorActionsApi.describe_gcp_connector_action([param1, param2, ...])

JavaScript

GCPConnectorActionsApi.describeGCPConnectorAction([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
actionID
required
integer <int64> \d+

The ID number of the GCP Connector action.

Example: 1
gcpConnectorID
required
integer <int32> \d+

The ID number of the GCP Connector.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Responses
200

successful operation

403

Not authorized to view the action.

404

The action does not exist.

Request samples
import com.trendmicro.deepsecurity.ApiClient;
import com.trendmicro.deepsecurity.Configuration;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.auth.ApiKeyAuth;
import com.trendmicro.deepsecurity.ApiException;
import com.trendmicro.deepsecurity.api.GcpConnectorActionsApi;
import com.trendmicro.deepsecurity.model.Action;


public class DescribeGCPConnectorActionExample {
	
	public static void main(String[] args) {
		// Setup
		ApiClient defaultClient = Configuration.getDefaultApiClient();
		defaultClient.setBasePath("YOUR HOST");

		// Authentication
		ApiKeyAuth Legacy API Key = (ApiKeyAuth) defaultClient.getAuthentication("Legacy API Key");
		Legacy API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		ApiKeyAuth Trend Micro Cloud One API Key = (ApiKeyAuth) defaultClient.getAuthentication("Trend Micro Cloud One API Key");
		Trend Micro Cloud One API Key.setApiKey("YOUR API KEY");
		try {
			defaultClient.trustAllCertificates(false);
		} catch (Exception e) {
			System.err.println("An exception occurred when calling ApiClient.trustAllCertificates");
			e.printStackTrace();
		}
		
		// Initialization
		// Set Any Required Values
		GcpConnectorActionsApi instance = new GcpConnectorActionsApi();
		Integer gcpConnectorID = 1;
		Long actionID = 1L;
		String apiVersion = "YOUR VERSION";
		try {
			// Please replace the parameter values with yours
			Action result = instance.describeGCPConnectorAction(gcpConnectorID, actionID, apiVersion);
			System.out.println(result);
		} catch (ApiException e) {
			System.err.println("An exception occurred when calling GcpConnectorActionsApi.describeGCPConnectorAction");
			e.printStackTrace();
		}
	}
}

Response samples
application/json
{
  • "type": "synchronize",
  • "status": "SUBMITTED",
  • "submittedTime": 0,
  • "ID": 0
}

Create a connector action

post/gcpconnectors/{gcpConnectorID}/actions

Create a connector action by connector ID.

Related SDK Methods:
Java

GcpConnectorActionsApi.createGCPConnectorAction([param1, param2, ...])

Python

GCPConnectorActionsApi.create_gcp_connector_action([param1, param2, ...])

JavaScript

GCPConnectorActionsApi.createGCPConnectorAction([param1, param2, ...])

SecurityTrend_Micro_Cloud_One_API_Key or Legacy_API_Key
Request
path Parameters
gcpConnectorID
required
integer <int32> \d+

The ID number of the GCP Connector.

Example: 1
header Parameters
api-version
required
string

The version of the api being called.

Example: YOUR VERSION
Request Body schema: application/json

The property of the new GCP Connector action.

status
string

Status of the GCPConnectorAction.

Enum: "SUBMITTED" "RUNNING" "SUCCESS" "FAILED"
submittedTime
integer <int64>

Submitted time of the GCPConnectorAction.

type
string

Type of the GCPConnectorAction.

Value: "synchronize"
Responses
200

successful operation

403

Not authorized to view the action.

404

The action does not exist.

Request samples
application/json
{
  • "type": "synchronize",
  • "status": "SUBMITTED",
  • "submittedTime": 0
}
Response samples
application/json
{
  • "type": "synchronize",
  • "status": "SUBMITTED",
  • "submittedTime": 0,
  • "ID": 0
}