dtc:object : DTC object.

An object for all load balancer managed DTC objects.

Object Reference

References to dtc:object are object references.

The name part of a DTC object reference has the following components:

• Name of DTC object

Example: dtc:object/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCobject1

Restrictions

The object does not support the following operations:

• Create (insert)
• Delete
• Modify (update)
• Permissions
• 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): abstract_type, comment, display_type, name, status.

abstract_type

abstract_type

The abstract object type.

Type

String.

Search

The field is not available for search.

Notes

The abstract_type is part of the base object.

The abstract_type cannot be updated.

abstract_type cannot be written.

comment

comment

The comment for the DTC object; maximum 256 characters.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The comment is part of the base object.

The comment cannot be updated.

comment cannot be written.

display_type

display_type

The display object type.

Type

String.

Search

The field is not available for search.

Notes

The display_type is part of the base object.

The display_type cannot be updated.

display_type cannot be written.

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Create

The default value is empty.

Search

For how to search extensible attributes, see the following information.

ipv4_address_list

ipv4_address_list

The list of IPv4 addresses.

Type

String array.

Search

The field is not available for search.

Notes

The ipv4_address_list cannot be updated.

ipv4_address_list cannot be written.

ipv6_address_list

ipv6_address_list

The list of IPv6 addresses.

Type

String array.

Search

The field is not available for search.

Notes

The ipv6_address_list cannot be updated.

ipv6_address_list cannot be written.

name

name

The display name of the DTC object.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The name is part of the base object.

The name cannot be updated.

name cannot be written.

object

object

The specific DTC object.

Type

String.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The object cannot be updated.

object cannot be written.

status

status

The availability color status.

Type

String.

Valid values are:

• BLUE
• GRAY
• GREEN
• NONE
• RED
• YELLOW

Search

The field is not available for search.

Notes

The status is part of the base object.

The status cannot be updated.

status cannot be written.

status_time

status_time

The timestamp when status or health was last determined.

Type

Timestamp.

Search

The field is not available for search.

Notes

The status_time cannot be updated.

status_time 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.

status_member

status_member

The name of the status member to search for.

Type

String.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

status_member is a search-only field.

type

type

The type of the managed object to search for.

Type

String.

Valid values are:

• LBDN
• POOL
• SERVER

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

type is a search-only field.

Fields List

Field	Type	Req	R/O	Base	Search
abstract_type	String	N	Y	Y	N/A
comment	String	N	Y	Y	: = ~
display_type	String	N	Y	Y	N/A
extattrs	Extattr	N	N	N	ext
ipv4_address_list	[String]	N	Y	N	N/A
ipv6_address_list	[String]	N	Y	N	N/A
name	String	N	Y	Y	: = ~
object	String	N	Y	N	N/A
status	String	N	Y	Y	N/A
status_time	Timestamp	N	Y	N	N/A

Search-only Fields List

Field	Type	Search
status_member	String	: = ~
type	String	=