Querying a Reference Table
Function
This API is used to query a reference table.
URI
GET /v1/{project_id}/waf/valuelist/{valuelistid}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project. |
valuelistid |
Yes |
String |
Reference table ID. It can be obtained by calling the ListValueList API. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Content-Type |
Yes |
String |
Content type. Default: application/json;charset=utf8 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the reference table |
name |
String |
Reference table name. |
type |
String |
Reference table type |
description |
String |
Reference table description |
values |
Array of strings |
Value of the reference table |
producer |
Integer |
Source of the reference table.
|
timestamp |
Long |
Timestamp the rule is created. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Example Requests
The following example shows how to query a reference table in a project. The project ID is specified by project_id. The reference table ID is valuelistid.
GET https://{Endpoint}/v1/{project_id}/waf/valuelist/{valuelistid}?enterprise_project_id=0
Example Responses
Status code: 200
Request sent.
{ "id" : "63b1d9edf2594743bc7c6ee98527306c", "name" : "RPmvp0m4", "type" : "response_code", "values" : [ "500" ], "description" : "demo", "producer" : 1 }
Status Codes
Status Code |
Description |
---|---|
200 |
Request sent. |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server 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.