dtc:certificate : DTC Certificate object.¶
These are DTC health monitor certificates.
Object Reference¶
References to dtc:certificate are object references.
The name part of the DTC Certificate object reference has the following components:
Name of DTC Certificate
Example: dtc:certificate/ZG5zLm5ldHdvcmtfdmlldyQxMTk:DTCcert1
Restrictions¶
The object does not support the following operations:
Create (insert)
Delete
Modify (update)
Permissions
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.
certificate¶
- certificate¶
Reference to underlying X509Certificate.
Type
String.
This field supports nested return fields as described here.
Search
The field is not available for search.
Notes
The certificate cannot be updated.
certificate cannot be written.
in_use¶
- in_use¶
Determines whether the certificate is in use or not.
Type
Bool.
Search
The field is not available for search.
Notes
The in_use cannot be updated.
in_use 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.
certificate.issuer¶
- certificate.issuer¶
The issuer of the certificate to search for.
Type
String.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
certificate.issuer is a search-only field.
certificate.serial¶
- certificate.serial¶
The serial number of the certificate to search for.
Type
String.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
certificate.serial is a search-only field.
certificate.subject¶
- certificate.subject¶
The Distinguished Name of the certificate to search for.
Type
String.
Search
The field is available for search via
‘~=’ (regular expression)
‘=’ (exact equality)
‘:=’ (case insensitive search)
Notes
certificate.subject is a search-only field.
certificate.valid_not_after¶
- certificate.valid_not_after¶
The expiry date of the certificate to search for.
Type
Timestamp.
Search
The field is available for search via
‘!=’ (negative search)
‘<=’ (less than search)
‘=’ (exact equality)
‘>=’ (greater than search)
Notes
certificate.valid_not_after is a search-only field.
certificate.valid_not_before¶
- certificate.valid_not_before¶
The validity start date of the certificate to search for.
Type
Timestamp.
Search
The field is available for search via
‘!=’ (negative search)
‘<=’ (less than search)
‘=’ (exact equality)
‘>=’ (greater than search)
Notes
certificate.valid_not_before is a search-only field.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
certificate |
String |
N |
Y |
N |
N/A |
in_use |
Bool |
N |
Y |
N |
N/A |
Search-only Fields List¶
Field |
Type |
Search |
|---|---|---|
certificate.issuer |
String |
: = ~ |
certificate.serial |
String |
: = ~ |
certificate.subject |
String |
: = ~ |
certificate.valid_not_after |
Timestamp |
! < = > |
certificate.valid_not_before |
Timestamp |
! < = > |
