API Introduction
Bind one or more tags.
API Restrictions
None
URI
POST /v1/tagOpenApi/bindTag
Path Parameter
None
body parameter
Parameter | Required or Not | Parameter Type | Description | Example |
tags | Yes | Object[] | Object array |
Table tags
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | Required | String | External instance ID of the document database | a649077e15f349cb8b4cde6f7285a568 |
tagKey | Required | String | Tag Key | mongo |
tagValue | Required | String | Tag Value | 001 |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The XXX information is bound successfully | |
returnObj | Yes | Object | Return object. |
Sample Request
Request Header
None
Request parameter body
{
"tags": [
{
"tagKey": "mongo",
"tagValue": "001",
"prodInstId": "1231a9af6cf2431f8b7a03b18c44e529"
},
{
"tagKey": "mongo",
"tagValue": "002",
"prodInstId": "23319836bc4f4bff8ded0fa4cbe1acfe"
}
]
}Response Example
{
"statusCode": 800,
"message": "one or more tags are bound successfully",
"returnObj": null
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None