Querying Project Tags
Function
This API is used to query all secret tags of a user in a specified project.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/csms/tags
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
tags |
Array of TagResponse objects |
Tag list, which is the value pairs of tag keys and values.
|
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
String |
Tag key, |
|
values |
Array of strings |
Tag value set. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
ErrorDetail object |
Error message |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. |
|
error_msg |
String |
Error information returned for an error request. |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
ErrorDetail object |
Error message |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. |
|
error_msg |
String |
Error information returned for an error request. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
ErrorDetail object |
Error message |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. |
|
error_msg |
String |
Error information returned for an error request. |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
ErrorDetail object |
Error message |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. |
|
error_msg |
String |
Error information returned for an error request. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
ErrorDetail object |
Error message |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. |
|
error_msg |
String |
Error information returned for an error request. |
Status code: 502
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
ErrorDetail object |
Error message |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code returned for an error request. |
|
error_msg |
String |
Error information returned for an error request. |
Status code: 504
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
ErrorDetail object |
Error message |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{
"tags" : [ {
"key" : "key1",
"values" : [ "val1" ]
}, {
"key" : "key2",
"values" : [ "val2" ]
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
|
400 |
Invalid request parameter. |
|
401 |
A username and password are required. |
|
403 |
Authentication failed. |
|
404 |
The requested resource does not exist or is not found. |
|
500 |
Internal service error. |
|
502 |
Failed to complete the request because the server receives an invalid response from an upstream server. |
|
504 |
Gateway timed out. |
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.