Create a Tag
Description
CreateTag API is used for creating a tag.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| Action | String | Required | API name, a system required parameter. Value: CreateTag. |
| TagName | String | Required | Tag name |
For other request parameters, see Public parameters.
Response parameters
| Name | Type | Description |
|---|---|---|
| TagId | int | Tag id |
For more information about public response parameters, see Public parameters.
Error codes
| Error code | Description | HTTP status code | Meaning |
|---|---|---|---|
| InvalidTagNumber.Malformed | The number of tags exceeded the quota. | ||
| InvalidTagName.Malformed | The specified tag name is wrongly formed. | ||
| InvalidTagName.Duplicate | The specified tag name already exists. | ||
| InternalError | Unknown error. |
Delete Tag
Description
DeleteTag API is used for deleting a tag.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| Action | String | Required | API name, a system required parameter. Value: DeleteTag. |
| TagId | String | Required | Tag id |
For other request parameters, see Public parameters.
Response parameters
For more information about public response parameters, see Public parameters.
Error codes
| Error code | Description | HTTP status code | Meaning |
|---|---|---|---|
| InvalidTagId.Malformed | The specified tag id is not exists. |
Get Tags
Description
QueryTagByParam API is used for querying tags.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| Action | String | Required | API name, a system required parameter. Value: QueryTagByParam. |
| KeyWord | String | Optional | Tag name， length 1-50, Example：1aTag |
For other request parameters, see Public parameters.
Response parameters
| Name | Type | Description |
|---|---|---|
| pageNumber | Int | |
| pageSize | Int | |
| totalCount | Int | |
| data | Array | data |
data
| Name | Type | Description |
|---|---|---|
| tagName | String | Tag name |
| TagId | int | Tag id |
For more information about public response parameters, see Public parameters.
Error codes
| Error code | Description | HTTP status code | Meaning |
|---|---|---|---|
| InvalidKeyword.Malformed | The specified param is wrongly formed. |
Modify Tag
Description
ModifyTag API is used for modifying a tag.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| Action | String | Required | API name, a system required parameter. Value: ModifyTag. |
| TagId | Integer | Required | Tag id |
| TagName | String | Required | Tag name |
For other request parameters, see Public parameters.
Response parameters
For more information about public response parameters, see Public parameters.
Error codes
| Error code | Description | HTTP status code | Meaning |
|---|---|---|---|
| InvalidTag.NotFound | The specified tag was not found. | ||
| InvalidTagId.Malformed | The specified tag id is not exists. | ||
| InvalidTagNumber.Malformed | The number of tags exceeded the quota. | ||
| InvalidTagName.Malformed | The specified tag name is wrongly formed. | ||
| InvalidTagName.Duplicate | The specified tag name already exists. | ||
| InternalError | Unknown error. |