This object represents the Cloud Grid.
References to grid:cloudapi are object references. The name part of a Grid Cloud API object reference has the following components:
- The ‘grid’ string
Example: grid:cloudapi/ZGldHdvcmtfdmlldyQxMTk:grid
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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): allow_api_admins, allowed_api_admins, enable_recycle_bin.
Defines administrators who can perform cloud API requests on the Grid Master. The valid value is NONE (no administrator), ALL (all administrators), or LIST (administrators on the ACL).
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
The allow_api_admins is part of the base object.
The list of administrators who can perform cloud API requests on the Cloud Platform Appliance.
Type
A/An Cloud user struct array.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
The allowed_api_admins is part of the base object.
Determines whether the recycle bin for deleted cloud objects is enabled or not on the Grid Master.
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
The enable_recycle_bin is part of the base object.
Structure containing all the information related to Gateway configuration for the Grid Master
Type
A/An Gateway config struct.
Create
The default value is undefined.
Search
The field is not available for search.
Field | Type | Req | R/O | Base | Search |
---|---|---|---|---|---|
allow_api_admins | String | N | N | Y | N/A |
allowed_api_admins | [struct] | N | N | Y | N/A |
enable_recycle_bin | Bool | N | N | Y | N/A |
gateway_config | struct | N | N | N | N/A |