db_objects : The DB Objects object.¶
The DB Objects object is used to search for changes in objects of the Infoblox Grid.
Note¶
You must specify the parameter start_sequence_id for incremental sync searches. Absence of start_sequence_id triggers reading records with revision_id greater than zero. All object fields are returned when you set all_object_types_supported_in_version search field, but do not specify the _return_fields option.
Object Reference¶
References to db_objects are object references.
The name part of the DB Objects object reference has the following components:
The sequence id.
- Example:
db_objects/Li51c2VyX3Byb2ZpbGUkMjI:322:32
Restrictions¶
The object does not support the following operations:
Create (insert)
Delete
Modify (update)
Read by object reference
Global search (searches via the search object)
Scheduling
CSV export
The object cannot be managed on Cloud Platform members.
Fields¶
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): last_sequence_id, object, object_type, unique_id.
last_sequence_id¶
- last_sequence_id¶
The last returned sequence ID.
Type
String.
Search
The field is not available for search.
Notes
The last_sequence_id is part of the base object.
The last_sequence_id cannot be updated.
last_sequence_id cannot be written.
object¶
- object¶
The record object when supported by WAPI. Otherwise, the value is “None”.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The object is part of the base object.
The object cannot be updated.
object cannot be written.
object_type¶
- object_type¶
The object type. This is undefined if the object is not supported.
Type
String.
Search
The field is not available for search.
Notes
The object_type is part of the base object.
The object_type cannot be updated.
object_type cannot be written.
unique_id¶
- unique_id¶
The unique ID of the requested object.
Type
String.
Search
The field is not available for search.
Notes
The unique_id is part of the base object.
The unique_id cannot be updated.
unique_id cannot be written.
Search-only Fields¶
These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.
all_object_types_supported_in_version¶
- all_object_types_supported_in_version¶
You can use this search parameter to search for all objects supported in the specified WAPI. You must specify only one of the following search parameters: object_types, all_object_types_supported_in_version.
Type
String.
- Valid values are:
2.5
2.7
Search
The field is available for search via
‘=’ (exact equality)
Notes
all_object_types_supported_in_version is a search-only field.
exclude_deleted¶
- exclude_deleted¶
Determines whether deleted objects must be excluded or not.
Type
Bool.
Search
The field is available for search via
‘=’ (exact equality)
Notes
exclude_deleted is a search-only field.
object_types¶
- object_types¶
The object types to search for. You must specify only one of thefollowing search parameters: object_types, all_object_types_supported_in_version.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
object_types is a search-only field.
start_sequence_id¶
- start_sequence_id¶
The start sequence ID to search for.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
start_sequence_id is a search-only field.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
---|---|---|---|---|---|
last_sequence_id |
String |
N |
Y |
Y |
N/A |
object |
String |
N |
Y |
Y |
N/A |
object_type |
String |
N |
Y |
Y |
N/A |
unique_id |
String |
N |
Y |
Y |
N/A |
Search-only Fields List¶
Field |
Type |
Search |
---|---|---|
all_object_types_supported_in_version |
String |
= |
exclude_deleted |
Bool |
= |
object_types |
String |
= |
start_sequence_id |
String |
= |