Querying the Operation Connection List
Function
This API is used to query the operation connection list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/assetcredentials
|
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Definition Offset. Constraints N/A Range N/A Default Value N/A |
|
limit |
No |
Integer |
Definition Data volume. Constraints N/A Range N/A Default Value N/A |
|
name |
No |
String |
Connection name. |
|
component_name |
No |
String |
Plug-in name. |
|
creator_name |
No |
String |
Creator. |
|
modifier_name |
No |
String |
User who performed the modification. |
|
description |
No |
String |
Description. |
|
create_start_time |
No |
String |
Creation start time. |
|
create_end_time |
No |
String |
Creation end time. |
|
update_start_time |
No |
String |
Modification start time. |
|
update_end_time |
No |
String |
Modification end time. |
|
is_defense_type |
No |
Boolean |
Whether the operation connection is used for emergency policies. |
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 |
|
content-type |
Yes |
String |
Definition Content type. Constraints N/A Range Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
message |
String |
Error message. |
|
total |
Integer |
Total data volume. |
|
asset |
Array of AssetInfoResponseBody objects |
Response body for operating a connection. |
|
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
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Query the operation connection list of a workspace.
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/assetcredentials
Example Responses
Status code: 200
Request succeeded.
{
"code" : "00000000",
"message" : "",
"total" : 1,
"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 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 ListConnectionsSolution { 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(); ListConnectionsRequest request = new ListConnectionsRequest(); request.withWorkspaceId("{workspace_id}"); try { ListConnectionsResponse response = client.listConnections(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 = ListConnectionsRequest() request.workspace_id = "{workspace_id}" response = client.list_connections(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.ListConnectionsRequest{} request.WorkspaceId = "{workspace_id}" response, err := client.ListConnections(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 |
Request succeeded. |
|
400 |
Invalid request parameters. |
|
500 |
Request failed. |
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