Creating a Data Delivery
Function
This API is used to create a data delivery.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/siem/shippers
|
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 Value Range N/A Default value N/A |
|
workspace_id |
Yes |
String |
Workspace ID. |
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
consumption_type |
No |
Integer |
Consumption type. 0: real-time; 1: scheduling. |
|
dataspace_id |
No |
String |
Data space ID. |
|
dataspace_name |
No |
String |
Data space name. |
|
domain_id |
No |
String |
Tenant ID. |
|
pipe_id |
No |
String |
Pipeline ID. |
|
pipe_name |
No |
String |
Pipeline name. |
|
project_id |
No |
String |
Project ID. |
|
shipper_destination |
No |
shipper_destination object |
Delivery destination. |
|
shipper_name |
No |
String |
Delivery name. |
|
shipper_source |
No |
shipper_source object |
Delivery source. |
|
version |
No |
String |
Version information. |
|
workspace_id |
No |
String |
Workspace ID. |
|
workspace_name |
No |
String |
Workspace name. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
data_param |
No |
String |
Data parameters. |
|
destination_dataspace |
No |
String |
Destination data space ID. |
|
destination_dataspace_name |
No |
String |
Destination data space name. |
|
destination_identity_role |
No |
String |
Destination identity role. |
|
destination_table |
No |
String |
Destination table ID. |
|
destination_table_name |
No |
String |
Destination table name. |
|
destination_pipe |
No |
String |
Destination pipeline ID. |
|
destination_pipe_name |
No |
String |
Destination pipeline name. |
|
destination_region |
No |
String |
Destination region information. |
|
destination_shipper_type |
No |
Integer |
Destination delivery type. |
|
destination_workspace |
No |
String |
Destination workspace ID. |
|
destination_workspace_name |
No |
String |
Destination workspace name. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
region |
No |
String |
Region information. |
|
source_dataspace |
No |
String |
Source data space ID. |
|
source_dataspace_name |
No |
String |
Source data space name. |
|
source_identity_role |
No |
String |
Source identity role. |
|
source_table |
No |
String |
Source table ID. |
|
source_table_name |
No |
String |
Source table name. |
|
source_pipe |
No |
String |
Source pipeline ID. |
|
source_pipe_name |
No |
String |
Source pipeline name. |
|
source_type |
No |
Integer |
Source type. |
|
source_workspace |
No |
String |
Source workspace ID. |
|
source_workspace_name |
No |
String |
Source workspace name. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
Integer |
Error code. The value 0 indicates a success. Other values indicate an error. |
|
data |
Integer |
Returned data. |
|
msg |
String |
Returned status information. |
Example Requests
{ }
Example Responses
Status code: 200
Successful.
{ }
SDK Sample Code
The SDK sample code is as follows.
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 |
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 CreateShipperSolution { 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(); CreateShipperRequest request = new CreateShipperRequest(); request.withWorkspaceId("{workspace_id}"); CreateShipperBody body = new CreateShipperBody(); request.withBody(body); try { CreateShipperResponse response = client.createShipper(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 |
# 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 = CreateShipperRequest() request.workspace_id = "{workspace_id}" request.body = CreateShipperBody( ) response = client.create_shipper(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 |
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.CreateShipperRequest{} request.WorkspaceId = "{workspace_id}" request.Body = &model.CreateShipperBody{ } response, err := client.CreateShipper(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 |
Successful. |
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