Querying Component Configurations
Function
This API is used to query component configurations.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/workspaces/{workspace_id}/components/{component_id}/configurations
|
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. |
|
component_id |
Yes |
String |
Component ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
Long |
Number of records on each page. |
|
offset |
No |
Integer |
Definition Offset. Constraints N/A Range N/A Default Value N/A |
|
sort_key |
No |
String |
Sorting by attribute. |
|
sort_dir |
No |
String |
Sorting order. The value can be ASC or DESC. |
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 |
|---|---|---|
|
count |
Long |
Component configuration quantity. |
|
records |
Array of ComponentConfiguration objects |
Component configuration list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
component_id |
String |
Component ID. |
|
component_name |
String |
Component name. |
|
config_status |
String |
Definition Node configuration status. Constraints N/A Range Default Value N/A |
|
create_time |
Integer |
Millisecond timestamp. |
|
fail_deploy_message |
String |
Deployment failure message. |
|
ip_address |
String |
IP address. |
|
list |
Array of ComponentConfigurationParam objects |
Component configuration parameters. |
|
monitor |
Monitor object |
Monitor. |
|
node_apply_fail_enum |
String |
Definition Node application status and reason.
Constraints N/A Range Default Value N/A |
|
node_expansion |
IsapNodeExpansion object |
Node extension information. |
|
node_id |
String |
Node ID. |
|
node_name |
String |
Node name. |
|
private_ip_address |
String |
IP address. |
|
region |
String |
Region. |
|
specification |
String |
Specifications. |
|
vpc_endpoint_address |
String |
VPC endpoint address. |
|
vpc_endpoint_id |
String |
VPC endpoint ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
component_id |
String |
Component ID. |
|
configuration_id |
String |
Configuration ID. |
|
file_name |
String |
File name. |
|
file_path |
String |
File path. |
|
file_type |
String |
Definition File type. Constraints N/A Range Default Value N/A |
|
node_id |
String |
Node ID. |
|
param |
String |
Parameter. |
|
type |
String |
Definition Configuration type. Constraints N/A Range Default Value N/A |
|
version |
Integer |
Version. |
|
Parameter |
Type |
Description |
|---|---|---|
|
cpu_idle |
String |
Percentage of CPU idle time. |
|
cpu_usage |
String |
Current CPU usage. |
|
disk_count |
String |
Number of disk devices in the system. |
|
disk_usage |
String |
Current disk space usage. |
|
down_pps |
String |
Number of downloaded data packets per second. |
|
health_status |
String |
Definition Health status of nodes. NORMAL: normal Constraints N/A Range Default Value N/A |
|
heart_beat |
String |
Definition Whether the node can successfully receive the heartbeat signal. Constraints N/A Range Default Value N/A |
|
heart_beat_time |
Long |
Time when the last heartbeat signal was received. |
|
memory_cache |
String |
Memory size of cached data. |
|
memory_count |
String |
Number of physical memory modules. |
|
memory_free |
String |
Current free physical memory. |
|
memory_shared |
String |
Total memory shared by multiple processes. |
|
memory_usage |
String |
Used physical memory. |
|
mini_on_online |
String |
Online or not. |
|
read_rate |
String |
Disk read rate. |
|
up_pps |
String |
Number of uploaded data packets per second. |
|
write_rate |
String |
Disk write rate. |
|
Parameter |
Type |
Description |
|---|---|---|
|
custom_label |
String |
Custom tag. |
|
data_center |
String |
Data center. |
|
description |
String |
Description. |
|
maintainer |
String |
Maintenance engineer. |
|
network_plane |
String |
Network plane. |
|
node_id |
String |
UUID |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
Status code: 200
Successful.
{
"count" : 1,
"records" : [ {
"component_id" : "1603635xxx1444",
"component_name" : "logstash",
"config_status" : "APPLIED",
"create_time" : 1768550588077,
"list" : [ {
"component_id" : "1603635xxx1444",
"configuration_id" : "174",
"file_name" : "log4j2.properties",
"file_type" : "LOG4J2",
"node_id" : "9c77d412xxx89d2",
"param" : "{\"a.eventEol\":\"true\"}",
"type" : "CURRENT_APPLY"
}, {
"component_id" : "1603635xxx1444",
"configuration_id" : "174",
"file_name" : "jvm.options",
"file_type" : "JVM",
"node_id" : "9c77d412xxx89d2",
"param" : "{\"-Xmx\":\"2048M\"}",
"type" : "CURRENT_APPLY"
} ],
"node_id" : "9c77d412xxx89d2",
"node_name" : "ecs-xxx-isap",
"specification" : "2U|4G|140G"
} ]
}
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 |
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 ListComponentConfigurationSolution { 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(); ListComponentConfigurationRequest request = new ListComponentConfigurationRequest(); request.withWorkspaceId("{workspace_id}"); request.withComponentId("{component_id}"); try { ListComponentConfigurationResponse response = client.listComponentConfiguration(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 |
# 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 = ListComponentConfigurationRequest() request.workspace_id = "{workspace_id}" request.component_id = "{component_id}" response = client.list_component_configuration(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 |
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.ListComponentConfigurationRequest{} request.WorkspaceId = "{workspace_id}" request.ComponentId = "{component_id}" response, err := client.ListComponentConfiguration(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. |
|
400 |
Error response. |
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