Creating a Lite Server Supernode Tag
Function
This API is used to add a custom tag to a Lite Server supernode. It is used when you need to manage Lite Server supernodes by category or mark specific information. Before using this API, ensure that the Lite Server supernode exists and you have the permission to create tags. After the creation, the tag is added to the specified supernode. You can quickly search for and manage the supernode by tag. If the Lite Server supernode does not exist, the tag already exists, or you do not have the permission to perform operations on the supernode, the API returns an error message.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
POST /v1/{project_id}/dev-servers/hyperinstance/{id}/tags/create
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
Yes |
String |
Definition: Lite Server supernode ID. |
|
project_id |
Yes |
String |
Definition: Project ID Constraints: For details, see Obtaining a Project ID and Name. Range: N/A Default Value: N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
tags |
Yes |
Array of TmsTag objects |
Definition: Tag list. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
key |
Yes |
String |
Definition: Key of a TMS tag. Constraints: The value can contain at most 128 characters and cannot start or end with sys. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. Range: N/A Default Value: N/A |
|
value |
Yes |
String |
Definition: Value of a TMS tag. Constraints: The value can contain at most 255 characters. Only letters, digits, spaces, and special characters (_.:/=+-@) are allowed. Range: N/A Default Value: N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-Request-Id |
String |
Link trace ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
tags |
Array of TmsTag objects |
Tag list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
String |
Definition: Key of a TMS tag. Constraints: The value can contain at most 128 characters and cannot start or end with sys. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. Range: N/A Default Value: N/A |
|
value |
String |
Definition: Value of a TMS tag. Constraints: The value can contain at most 255 characters. Only letters, digits, spaces, and special characters (_.:/=+-@) are allowed. Range: N/A Default Value: N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-Request-Id |
String |
Link trace ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Range: N/A |
|
error_msg |
String |
Definition: Error message. Range: N/A |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
X-Request-Id |
String |
Link trace ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Range: N/A |
|
error_msg |
String |
Definition: Error message. Range: N/A |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
X-Request-Id |
String |
Link trace ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Range: N/A |
|
error_msg |
String |
Definition: Error message. Range: N/A |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
X-Request-Id |
String |
Link trace ID. |
Example Requests
POST https://{endpoint}/v1/{project_id}/dev-servers/hyperinstance/{id}/tags/create
{
"tags" : [ {
"key" : "k1",
"value" : "v1"
}, {
"key" : "k2",
"value" : "v2"
}, {
"key" : "k3",
"value" : "v3"
}, {
"key" : "k4",
"value" : "v4"
} ]
}
Example Responses
Status code: 200
Definition: Response body for creating a Lite Server supernode tag.
{
"tags" : [ {
"key" : "k1",
"value" : "v1"
}, {
"key" : "k2",
"value" : "v2"
}, {
"key" : "k3",
"value" : "v3"
}, {
"key" : "k4",
"value" : "v4"
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Definition: Response body for creating a Lite Server supernode tag. |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
500 |
Server Internal Error |
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