Obtaining the Device List
Function
This API is used to obtain the information list of all devices in a project.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/devices
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
Integer |
Number of records on each page. |
|
offset |
No |
Integer |
Pagination offset. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
devices |
Array of Device objects |
Device information list. |
|
total |
Integer |
Total number of devices. |
|
Parameter |
Type |
Description |
|---|---|---|
|
create_time |
Long |
Creation time. |
|
description |
String |
Description. |
|
id |
String |
Device ID. |
|
ip |
String |
Device IP address. |
|
manage_url |
String |
Management address. |
|
mode |
String |
Deployment mode. |
|
name |
String |
Device name. |
|
related_datasource_policy_list |
Array of RelatedDatasourceInfo objects |
Associated policy. |
|
status |
String |
Status. |
|
subnet_id |
String |
Subnet ID. |
|
type |
Integer |
Device type, which can be 0 (application data audit), 1 (application data security gateway), 2 (database firewall), 3 (database encryption), 4 (static data masking instance), or 5 (dynamic database masking instance). |
|
update_time |
Long |
Update time. |
|
version |
String |
Version. |
|
vpc_id |
String |
VPC ID. |
|
Parameter |
Type |
Description |
|---|---|---|
|
datasource_address |
String |
Data source address. |
|
datasource_id |
String |
Data source asset ID. |
|
datasource_port |
Integer |
Data source port. |
|
ddm_policies |
Array of DdmPolicy objects |
List of associated dynamic masking policies. |
|
gde_policies |
Array of GdePolicy objects |
List of associated encryption policies. |
|
proxy_port |
Integer |
Agent port. |
|
sdm_policies |
Array of SdmPolicy objects |
array |
|
Parameter |
Type |
Description |
|---|---|---|
|
columns |
Array of Column objects |
Columns configured for the policy. |
|
namespace |
String |
Namespace name. |
|
table |
String |
Table name. |
|
Parameter |
Type |
Description |
|---|---|---|
|
action |
Integer |
1: encryption, 2: decryption. |
|
alg |
String |
Encryption algorithm, which can be sm4, aes-128, or aes-256. |
|
columns |
Array of Column objects |
Column information to be encrypted. |
|
table |
String |
Table name. |
|
Parameter |
Type |
Description |
|---|---|---|
|
columns |
Array of Column objects |
Column information. |
|
do_mask |
Boolean |
Whether to mask data. |
|
do_move |
Boolean |
Whether to migrate data. |
|
namespace |
String |
Namespace, which is only available for HBase. |
|
table |
String |
Table name. |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Query result. |
|
401 |
Unauthorized. The user is not logged in or the token is invalid. |
|
403 |
Unauthorized to access the resource. |
|
404 |
The specified project does not exist. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot