Creating a Configuration Application
Function
This API is used to create a configuration application.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/workspaces/{workspace_id}/components/{component_id}/configurations/application
|
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. |
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 |
|---|---|---|---|
|
configuration |
Yes |
Array of ConfigurationDetail objects |
Configuration list. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
config_status |
No |
String |
Definition Node deployment status.
Constraints N/A Range
Default Value N/A |
|
list |
Yes |
Array of FileConfiguration objects |
File configuration list. |
|
node_id |
No |
String |
Node ID. |
|
node_name |
No |
String |
Node name. |
|
specification |
No |
String |
Specifications. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
file_name |
No |
String |
File name. |
|
file_type |
Yes |
String |
Definition File type.
Constraints N/A Range
Default Value N/A |
|
node_id |
No |
String |
Node ID. |
|
param |
Yes |
Map<String,String> |
Parameter. |
|
type |
No |
String |
Definition Configuration type.
Constraints N/A Range
Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
apply_fail_list |
Array of ComponentConfiguration objects |
List of instances that fail to be created. |
|
apply_success_list |
Array of ComponentConfiguration objects |
List of instances that are successfully created. |
|
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
None
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