Querying Delivery Information
Function
This API is used to query delivery information.
Calling Method
For details, see Calling APIs.
URI
GET /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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
dataspace_id |
No |
String |
Data space ID. |
|
pipe_id |
No |
String |
Pipeline ID. |
|
shipper_name |
No |
String |
Delivery name. |
|
shipper_source_region |
No |
String |
Data source region. |
|
shipper_source_strategy |
No |
String |
Data source consumption policy. |
|
shipper_consumption_type |
No |
String |
Data source consumption type. |
|
destination_shipper_type |
No |
String |
Destination delivery type. |
|
shipper_status |
No |
String |
Data delivery status. |
|
create_time |
No |
String |
Creation time. |
|
limit |
No |
Long |
Number of records on each page. |
|
offset |
No |
Long |
Page number. |
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 |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
Integer |
Error code. The value 0 indicates a success. Other values indicate an error. |
|
data |
ApiResponseData object |
Data information. |
|
msg |
String |
Returned status information, which describes the result of the current request. |
|
Parameter |
Type |
Description |
|---|---|---|
|
data |
Array of ApiResponseDataItem objects |
Result data. |
|
limit |
Integer |
Number of records displayed on each page. |
|
offset |
Integer |
Start offset of the current page. |
|
total |
Integer |
Total number of records. |
|
Parameter |
Type |
Description |
|---|---|---|
|
consumption_type |
Integer |
Consumption type. It is defined based on services. |
|
create_time |
Long |
Creation time, which is a timestamp in milliseconds. |
|
dataspace_id |
String |
Data space ID, which is unique. |
|
dataspace_name |
String |
Data space name. |
|
domain_id |
String |
Domain ID, which is unique. |
|
id |
Integer |
Unique ID. |
|
pipe_id |
String |
Pipeline ID, which is unique. |
|
pipe_name |
String |
Pipeline name. |
|
project_id |
String |
Project ID, which is unique. |
|
shipper_destination |
ShipperDestination object |
Delivery destination. |
|
shipper_id |
String |
Shipping ID, which is unique. |
|
shipper_name |
String |
Shipping name. |
|
shipper_source |
ShipperSource object |
Delivery source. |
|
status |
Integer |
Status code. The specific meaning depends on the service definition. |
|
update_time |
Long |
Update time, which is a timestamp in milliseconds. |
|
version |
String |
Version information. |
|
workspace_id |
String |
Workspace ID, which uniquely identifies a workspace. |
|
Parameter |
Type |
Description |
|---|---|---|
|
data_param |
String |
Data parameter, which is in JSON format. |
|
data_type |
Integer |
Data type. It is defined based on services. |
|
dataspace |
String |
Data space ID. |
|
dataspace_name |
String |
Data space name. |
|
destination_info |
String |
Details about the destination. |
|
id |
Integer |
Unique ID. |
|
identity |
String |
Identity ID. |
|
pipe |
String |
Pipeline ID. |
|
pipe_name |
String |
Pipeline name. |
|
region |
String |
Region information. |
|
type |
Integer |
Type code. It is defined based on services. |
|
workspace |
String |
Workspace ID. |
|
workspace_name |
String |
Workspace name. |
|
Parameter |
Type |
Description |
|---|---|---|
|
data_type |
Integer |
Data type. It is defined based on services. |
|
dataspace |
String |
Data space ID. |
|
dataspace_name |
String |
Data space name. |
|
id |
Integer |
Unique ID. |
|
identity |
String |
Identity ID. |
|
pipe |
String |
Pipeline ID. |
|
pipe_name |
String |
Pipeline name. |
|
region |
String |
Region information. |
|
type |
Integer |
Type code. It is defined based on services. |
|
workspace |
String |
Workspace ID. |
|
workspace_name |
String |
Workspace name. |
Example Requests
None
Example Responses
Status code: 200
Successful.
{
"code" : 0,
"data" : {
"limit" : 1,
"total" : 1,
"data" : [ {
"consumption_type" : 0,
"create_time" : 1749539278902,
"domain_id" : "0996e744f600f3180f34c014f001b7c0",
"id" : 37,
"project_id" : "c796dfc5f1644915ae072b7642a2cd93",
"shipper_destination" : {
"data_type" : 0,
"destination_info" : "test",
"id" : 92,
"identity" : "table-strategy",
"region" : "test-region",
"type" : 1,
"workspace" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155",
"workspace_name" : "test"
},
"shipper_id" : "dcda642e-29bd-44c4-8ba7-cb95e55be180",
"shipper_name" : "ceshi",
"shipper_source" : {
"data_type" : 0,
"id" : 91,
"identity" : "table-strategy",
"region" : "test-region",
"type" : 0,
"workspace" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155",
"workspace_name" : "test"
},
"status" : 0,
"update_time" : 1749539278902,
"version" : "v2",
"workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155"
} ],
"offset" : 0
},
"msg" : "success"
}
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 |
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 ListShippersSolution { 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(); ListShippersRequest request = new ListShippersRequest(); request.withWorkspaceId("{workspace_id}"); try { ListShippersResponse response = client.listShippers(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 |
# 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 = ListShippersRequest() request.workspace_id = "{workspace_id}" response = client.list_shippers(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 |
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.ListShippersRequest{} request.WorkspaceId = "{workspace_id}" response, err := client.ListShippers(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