All Products
Search
Document Center

Elastic Desktop Service:ModifyCustomizedListHeaders

Last Updated:Jul 25, 2024

Modifies the layouts of cloud computer list headers, such as the required fields and the display and hide settings.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:ModifyCustomizedListHeadersupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ListTypestringNo

The type of the list.

Valid values:

  • desktop: cloud computer

desktop
Headersarray<object>No

The headers.

objectNo

The header.

HeaderKeystringNo

The key of the header.

Note All header keys of the list must be specified.

Valid values:

  • desktop_id_name: the IDs and names of the cloud computers.

  • system_data_disk: the system disks and data disks of the cloud computers.

  • office_site_type: the office network types of the cloud computers.

  • create_time: the time when the cloud computers are created.

  • ip: the IP addresses of the cloud computers.

  • spec_system_protocol: the instance types, OSs, and protocol types of the cloud computers.

  • monitor: the monitoring information of the cloud computers.

  • assigned_users: the number of end users that are assigned to the cloud computers.

  • encryption: indicates whether the cloud computers are encrypted.

  • office_site_id_name: the IDs and names of the office networks.

  • pay_type: the billing methods of the cloud computers.

  • tag: the tags that are attached to the cloud computers.

  • hostname: the hostnames of the cloud computers.

  • status: the statuses of the cloud computers.

  • current_user: the current end users of the cloud computers.

pay_type
DisplayTypestringNo

The display type of the header.

Note For the desktop_id_name and office_site_id_name head keys, set the value of this parameter to required. For other header keys, set the value of this parameter to display or hide based on your requirements.
display

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history