Querying Tag Values
Function
This API is used to query the values of a specified tag.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/aom/api/v1/label/{label_name}/values
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        label_name  | 
      
        Yes  | 
      
        String  | 
      
        Tag specified for query. You can obtain tag names by calling the API Obtaining the Tag Name List Using the POST Method.  | 
     
| 
        project_id  | 
      
        Yes  | 
      
        String  | 
      
        Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.  | 
     
Request Parameters
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        X-Auth-Token  | 
      
        Yes  | 
      
        String  | 
      
        User token obtained from IAM. For details, see Obtaining a Token.  | 
     
Response Parameters
Status code: 200
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        status  | 
      
        String  | 
      
        Response status.  | 
     
| 
        data  | 
      
        Array of strings  | 
      
        Tag value.  | 
     
Status code: 400
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        status  | 
      
        String  | 
      
        Response status.  | 
     
| 
        errorType  | 
      
        String  | 
      
        Error type.  | 
     
| 
        error  | 
      
        String  | 
      
        Error message.  | 
     
Status code: 403
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        status  | 
      
        String  | 
      
        Response status.  | 
     
| 
        errorType  | 
      
        String  | 
      
        Error type.  | 
     
| 
        error  | 
      
        String  | 
      
        Error message.  | 
     
Status code: 422
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        status  | 
      
        String  | 
      
        Response status.  | 
     
| 
        errorType  | 
      
        String  | 
      
        Error type.  | 
     
| 
        error  | 
      
        String  | 
      
        Error message.  | 
     
Status code: 503
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        status  | 
      
        String  | 
      
        Response status.  | 
     
| 
        errorType  | 
      
        String  | 
      
        Error type.  | 
     
| 
        error  | 
      
        String  | 
      
        Error message.  | 
     
Example Requests
Query all values of the "job" tag.
https://{EndPoint}/v1/{project_id}/aom/api/v1/label/job/values
 Example Responses
Status code: 200
OK: The request is successful.
{
  "status" : "success",
  "data" : [ "node", "prometheus" ]
}
  Status code: 400
Bad Request: The request is invalid. The client should not repeat the request without modifications.
{
  "status" : "error",
  "errorType" : "bad_param",
  "error" : "param is invalid."
}
  Status code: 403
Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.
{
  "status" : "error",
  "errorType" : "auth",
  "error" : "auth project_id not pass."
}
  Status code: 422
Unprocessable: The expression cannot be executed.
{
  "status" : "error",
  "errorType" : "excution",
  "error" : "expression can't be executed."
}
  Status code: 503
Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.
{
  "status" : "error",
  "errorType" : "timeout",
  "error" : "query timed out in query execution."
}
 Status Codes
| 
        Status Code  | 
      
        Description  | 
     
|---|---|
| 
        200  | 
      
        OK: The request is successful.  | 
     
| 
        400  | 
      
        Bad Request: The request is invalid. The client should not repeat the request without modifications.  | 
     
| 
        403  | 
      
        Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.  | 
     
| 
        422  | 
      
        Unprocessable: The expression cannot be executed.  | 
     
| 
        503  | 
      
        Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.  | 
     
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.