_create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly Sortable |
_create_user |
ID of the user who created this resource |
string |
Readonly |
_last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly Sortable |
_last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
_links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
_protection |
Indicates protection status of this resource
Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
|
string |
Readonly |
_revision |
Generation of this resource config
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int |
|
_schema |
Schema for this resource |
string |
Readonly |
_self |
Link to this resource |
SelfResourceLink |
Readonly |
_system_owned |
Indicates system owned resource |
boolean |
Readonly |
config |
Profile Content
The config content of System Health Agent |
string |
Required |
description |
Description of this resource |
string |
Maximum length: 1024 Sortable |
display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255 Sortable |
enabled |
Profile Enablement Flag
The on-off switch of System Health Agent |
boolean |
|
id |
Unique identifier of this resource |
string |
Sortable |
plugin_id |
Plugin id
The id of System Health Agent plugin |
string |
Required |
resource_type |
Must be set to the value SystemHealthAgentProfile |
string |
|
tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
type |
Profile Type
The type of System Health Agent.
The System Health Agent plugin associated with given plugin id has already defined the profile type.
So the backend can obtain the type by the plugin definition directly. Mark this field as optional.
If need to check the type value by given plugin id, please call /systemhealth/plugins/.
|
SystemHealthAgentType |
|