All Products
Search
Document Center

Elastic Desktop Service:DescribeCustomizedListHeaders

Last Updated:Apr 18, 2023

Queries the header information of the desktop list.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
ListTypestringNo

The type of the list.

Enumeration Value:
  • desktop
desktop
LangTypestringNo

The language in which the exported cloud desktop list is displayed.

Enumeration Value:
  • zh-CN
  • en-GB
zh-CN

Response parameters

ParameterTypeDescriptionExample
object

The information that is returned.

RequestIdstring

The ID of the request.

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

The headers.

object

The header.

DisplayTypestring

The display type of the header. You can call the ModifyCustomizedListHeaders operation to modify the display type of the header.

Enumeration Value:
  • hide
  • display
  • required
display
HeaderKeystring

The key of the header.

pay_type
HeaderNamestring

The name of the header.

Cloud Desktop ID/Name

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Headers": [
    {
      "DisplayType": "display",
      "HeaderKey": "pay_type",
      "HeaderName": "Cloud Desktop ID/Name\n"
    }
  ]
}

Error codes

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