DescribeDesktops

Updated at:

Queries the details of one or more cloud desktops.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:DescribeDesktops

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

BusinessChannel

string

No

The business channel. Valid values: Enterprise: Enterprise Edition Business: Business Edition

Valid values:

  • Enterprise :

    Enterprise Edition.

  • AGENTIC_CLOUD_COMPUTER :

    Agent cloud desktop.

  • Business :

    Business Edition.

  • Lincore_team :

    Lincore Team Edition.

Enterprise

RegionId

string

Yes

The region ID. You can call the DescribeRegions operation to query the regions supported by WUYING Workspace.

cn-hangzhou

GroupId

string

No

The desktop group ID.

dg-boyczi8enfyc5****

DesktopStatus

string

No

The cloud desktop status.

Valid values:

  • Stopped :

    Stopped.

  • Starting :

    Starting.

  • Rebuilding :

    Rebuilding.

  • Running :

    Running.

  • Stopping :

    Stopping.

  • Expired :

    Expired.

  • Deleted :

    Deleted.

  • Pending :

    Pending.

Running

MaxResults

integer

No

The number of entries to return per page in a paging query.

  • Maximum value: 100.

  • Default value: 10.

10

NextToken

string

No

The token that is used to start the next query. If NextToken is empty, no more results exist.

caeba0bbb2be03f84eb48b699f0a4883

UserName

string

No

The username.

Alice

DesktopName

string

No

The cloud desktop name.

DemoComputer01

DirectoryId

string

No

The directory ID. This parameter is equivalent to the office network ID.

cn-hangzhou+dir-363353****

OfficeSiteId

string

No

The office network ID.

cn-hangzhou+dir-363353****

OfficeSiteName

string

No

The office network name.

default

PolicyGroupId

string

No

The cloud desktop policy ID.

system-all-enabled-policy

ChargeType

string

No

The billing method of the cloud desktop.

Valid values:

  • PostPaid :

    Pay-as-you-go [default value]

  • PrePaid :

    Subscription.

PostPaid

ExpiredTime

string

No

The expiration time of the subscription cloud desktop. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2022-12-31T15:59:59Z

ProtocolType

string

No

The protocol type.

Valid values:

  • HDX :

    HDX protocol.

  • ASP :

    ASP protocol developed by Alibaba Cloud [recommended]

ASP

DesktopId

array

No

The cloud desktop IDs. You can specify 1 to 100 IDs.

ecd-gx2x1dhsmucyy****

string

No

The cloud desktop ID.

ecd-gx2x1dhsmucyy****

EndUserId

array

No

The authorized users of the cloud desktop. You can specify 1 to 100 users.

Note

Only one user can connect to and use the cloud desktop at a time.

alice

string

No

The authorized user of the cloud desktop.

alice

ExcludedEndUserId

array

No

The authorized users of the cloud desktop to exclude. You can specify 1 to 100 users.

andy

string

No

The authorized user of the cloud desktop to exclude.

andy

FilterDesktopGroup

boolean

No

Specifies whether to exclude pooled cloud desktops (cloud desktops in a desktop group).

Valid values:

  • true :

    Exclude pooled cloud desktops [default value]

  • false :

    Do not exclude pooled cloud desktops.

false

ManagementFlag

string

No

The management flag.

Valid values:

  • Migrating :

    Migrating.

  • Updating :

    Updating.

  • NoFlag :

    No flag.

NoFlag

QueryFotaUpdate

boolean

No

Specifies whether to query the image version information of the cloud desktop.

Valid values:

  • true :

    Query the image upgrade information of the cloud desktop.

  • false :

    Do not query the image upgrade information of the cloud desktop [default value]

false

Tag

array<object>

No

The list of tags. A tag consists of a key-value pair and is used to identify a resource. You can use tags to manage cloud desktops in groups for easy search and batch operations. For more information, see Use tags to manage cloud desktops.

object

No

The tag key-value pair. You can add 1 to 20 key-value pairs to each cloud desktop. A tag key can correspond to only one tag value.

Key

string

No

The tag key. If you specify Tag, Key is required. The tag key can be up to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://, and cannot contain only spaces.

TestKey

Value

string

No

The tag value. The tag value can be up to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

TestValue

SnapshotPolicyId

string

No

The snapshot policy ID.

sp-hb12mclyne09xw***

OnlyDesktopGroup

boolean

No

Specifies whether to query only pooled cloud desktops (cloud desktops in a desktop group).

true

DesktopGroupId

string

No

The desktop group ID. If you specify DesktopId, the DesktopGroupId parameter is ignored. If DesktopId is empty, the system queries the DesktopId of all cloud desktops in the desktop group based on DesktopGroupId.

dg-2i8qxpv6t1a03****

OsTypes

array

No

The operating system type.

string

No

The operating system type.

Valid values:

  • Linux :

    Linux

  • Windows :

    Windows

Windows

DesktopType

string

No

The cloud desktop type. You can call the DescribeDesktopTypes operation to query the supported cloud desktop types.

eds.general.2c8g

ImageId

array

No

The list of image IDs.

string

No

The image ID.

m-2g65ljy3ynrdq****

DesktopStatusList

array

No

The list of cloud desktop statuses.

string

No

The cloud desktop status.

Valid values:

  • Stopped :

    Stopped.

  • Starting :

    Starting.

  • Rebuilding :

    Rebuilding.

  • Running :

    Running.

  • Stopping :

    Stopping.

  • Expired :

    Expired.

  • Deleted :

    Deleted.

  • Pending :

    Pending.

Stopped

GpuInstanceGroupId

string

No

The elastic GPU pool ID.

gp-0bm2iz1v6m6nx****

ReservePoolId

string

No

The resource reservation pool ID (rp-xxx). This parameter is used to filter cloud desktops precisely by reservation pool. If this parameter is not specified or is empty, cloud desktops are not filtered by reservation pool.

rp-xxx

QosRuleId

string

No

The public network bandwidth throttling rule ID.

qos-5605u0gelk200****

SubPayType

string

No

The billing method for the cloud desktop.

Valid values:

  • duration :

    Duration package [whitelist]

  • postPaid :

    Pay-as-you-go.

  • monthPackage :

    Monthly package (120 hours/250 hours)

  • prePaid :

    Monthly package (unlimited hours)

monthPackage

ResourceGroupId

string

No

The ID of the enterprise resource group.

rg-4hsvzbbmqdzu3s****

FillResourceGroup

boolean

No

Specifies whether to query the enterprise resource group information.

true

PageNumber

integer

No

The page number of the current page in a paging query.

1

PageSize

integer

No

The maximum number of entries per page in a paging query.

10

MultiResource

boolean

No

Specifies whether there are multiple resources.

false

IncludeAutoSnapshotPolicy

boolean

No

Specifies whether to include the automatic snapshot policy information in the response.

false

NetworkInterfaceIp

string

No

The private IP address.

192.168.1.1

PublicIp

string

No

The public IP address of the instance.

121.199.28.39

Response elements

Element

Type

Description

Example

object

The response information.

Desktops

array<object>

The details of the cloud desktops.

array<object>

The details of the cloud desktops.

AccountType

string

The account type.

SIMPLE

AgentProviderList

array

The list of agents supported by the cloud desktop.

string

The agent supported by the cloud desktop.

Wuying

BindAmount

integer

The maximum number of concurrent sessions allowed per cloud desktop in a multi-session cloud desktop pool.

2

BundleId

string

The ID of the cloud desktop template used by the cloud desktop.

b-2g65ljy4291vl****

BundleName

string

The name of the cloud desktop template used by the cloud desktop.

TemplateName

ChargeType

string

The billing method of the cloud desktop.

Valid values:

  • PostPaid :

    Pay-as-you-go [default value]

  • PrePaid :

    Subscription.

PostPaid

ConnectionStatus

string

The connection status of the user.

Valid values:

  • Unknown :

    Unknown.

  • Connected :

    Connected.

  • Disconnected :

    Disconnected.

Disconnected

Cpu

integer

The number of vCPUs.

2

CreationTime

string

The creation time of the cloud desktop. The time is in the ISO 8601 standard (UTC).

2020-11-06T08:28Z

DataDiskCategory

string

Note

This parameter is in invitational preview and is not available.

cloud_auto

DataDiskSize

string

Note

This parameter is in invitational preview and is not available.

80

DesktopGroupId

string

The ID of the cloud desktop pool to which the cloud desktop belongs. Default value: null.

dg-2i8qxpv6t1a03****

DesktopId

string

The cloud desktop ID.

ecd-gx2x1dhsmucyy****

DesktopName

string

The cloud desktop name.

DemoComputer01

DesktopStatus

string

The cloud desktop status.

Running

DesktopType

string

The specifications of the cloud desktop.

ecd.basic.large

DirectoryId

string

The directory ID. This is the same as the office network ID (OfficeSiteId).

cn-hangzhou+dir-363353****

DirectoryType

string

Note

This parameter is in invitational preview and is not available.

SIMPLE

Disks

array<object>

The disk information.

object

The disk information.

DiskCategory

string

The disk category. Valid values:

  • cloud_efficiency (ultra cloud disk)

  • cloud_auto (auto cloud disk)

  • cloud_essd (enhanced standard SSD cloud disk, supported only by specific instance types)

Valid values:

  • cloud_efficiency :

    Ultra disk.

  • cloud_auto :

    Auto disk.

  • cloud_essd :

    Enhanced standard SSD cloud disk. Supported only by specific instance types.

cloud_auto

DiskId

string

The disk ID.

d-jedbpr4sl9l37****

DiskSize

integer

The disk size. Unit: GiB.

80

DiskType

string

The disk type.

Valid values:

  • SYSTEM :

    System cloud disk.

  • DATA :

    Data cloud disk.

SYSTEM

PerformanceLevel

string

The performance level of the enhanced standard SSD cloud disk. This parameter is valid only when the cloud disk is an enhanced standard SSD cloud disk.

For more information about the differences between performance levels, see Enhanced standard SSD cloud disks.

Valid values:

  • PL1 :

    PL1

  • PL0 :

    PL0

  • PL3 :

    PL3

  • PL2 :

    PL2

PL0

DomainType

string

The domain type of the directory to which the cloud desktop belongs.

AD

DowngradeQuota

integer

The number of times the specifications can be downgraded.

3

DowngradedTimes

integer

The number of times the specifications have been downgraded.

0

EndUserIds

array

The IDs of the authorized users of the cloud desktop.

string

The IDs of the authorized users of the cloud desktop.

alice

EntraDomainName

string

The domain name of Microsoft Entra ID.

contoso.onmicrosoft.com

EnvId

string

The environment ID. This parameter is for internal use only.

adifa****

EnvType

string

The environment type. This parameter is for internal use only.

Private

ExpiredTime

string

The expiration time of the subscription cloud desktop. The time is in the ISO 8601 standard (UTC).

2021-12-31T15:59Z

FotaUpdate

object

The image version information of the cloud desktop.

CurrentAppVersion

string

The version number of the current image of the cloud desktop.

0.0.0-D-20220102.000000

NewAppVersion

string

The version number of the image to which the cloud desktop can be upgraded.

0.0.0-R-20220307.190736

ReleaseNote

string

The release notes of the upgradable image.

Test upgrade package 03-07

ReleaseNoteEn

string

The English description of the upgradable version.

What's new

ReleaseNoteJp

string

The Japanese description of the upgradable version.

リリースノート

Size

integer

The size of the installation package for the upgradable version. Unit: KB.

108815097

GpuCategory

integer

Specifies whether the cloud desktop is a GPU-accelerated cloud desktop.

0

GpuCount

number

The number of GPUs.

1

GpuDriverVersion

string

The GPU driver version of the cloud desktop.

471.68

GpuSpec

string

The GPU specifications.

NVIDIA T4

HibernationBeta

boolean

Note

This parameter is in invitational preview and is not available.

true

HibernationOptionsConfigured

boolean

Note

This parameter is in invitational preview and is not available.

true

HostName

string

The hostname.

testName

ImageId

string

The image ID.

m-4zfb6zj728hhr****

ImageName

string

The image name before the change.

Windows server 2019 Mainland

IsLdap

boolean

Indicates whether the directory is an LDAP directory.

ManagementFlag

string

The management flag.

Valid values:

  • Migrating :

    Migrating.

  • Updating :

    Updating.

  • NoFlag :

    No flag.

NoFlag

ManagementFlags

array

The management flag.

string

The management status of the cloud desktop.

Valid values:

  • Migrating :

    The office network is being migrated.

  • Hibernated :

    Hibernated.

  • UnderMaintenance :

    In maintenance mode.

  • MigratingProtocol :

    The protocol is being migrated.

  • EnterMaintenance :

    Entering maintenance mode.

  • WakingUp :

    Waking up.

  • Updating :

    Upgrading.

  • NoFlag :

    No status.

  • Assigning :

    Assigning users.

  • Hibernating :

    Hibernating.

["NoFlag"]

Memory

integer

The memory size. Unit: MiB.

4096

NetworkInterfaceId

string

The ID of the secondary elastic network interface (ENI) created by the cloud desktop service for a RAM or AD user. This ID cannot be modified.

123456

NetworkInterfaceIp

string

The IP address of the secondary ENI created by the cloud desktop service for a RAM or AD user.

192.168.XX.XX

OfficeSiteId

string

The office network ID.

cn-hangzhou+dir-363353****

OfficeSiteName

string

The office network name.

default

OfficeSiteType

string

The account system type of the office network.

Valid values:

  • SIMPLE :

    Convenience account.

  • AD_CONNECTOR :

    Enterprise AD account.

SIMPLE

OfficeSiteVpcType

string

The VPC type of the office network.

Valid values:

  • standard :

    Standard.

  • customized :

    Customized.

  • basic :

    Basic.

basic

OsType

string

The operating system type.

Windows

OsUpdate

object

The operating system update information of the cloud desktop.

CheckId

string

The ID of the health check task.

ck-8f2a1b****

PackageCount

integer

The number of patch packages to be updated.

3

Packages

array<object>

The list of system patch packages.

object

Description

string

The description of the NAS file system.

newDescription

Kb

string

The KB number of the system patch.

KB5032190

Title

string

The vulnerability name.

2021-05 Servicing Stack Update for Windows Server 2019 for x64-based Systems (KB5003243)

Platform

string

The operating system platform information.

Valid values:

  • Ubuntu :

    Ubuntu

  • Windows Server 2022 :

    Windows Server 2022

  • UOS :

    UOS

  • CentOS :

    CentOS

  • Windows Server 2019 :

    Windows Server 2019

  • Windows Server 2016 :

    Windows Server 2016

Ubuntu

PolicyGroupId

string

The cloud desktop policy ID.

system-all-enabled-policy

PolicyGroupIdList

array

The collection of cloud desktop policy IDs.

string

The cloud desktop policy ID.

pg-dasffjkdf*****

PolicyGroupName

string

The policy name.

All enabled policy

PolicyGroupNameList

array

The list of cloud desktop policy names.

string

The cloud desktop policy name.

TestPolicy01

Progress

string

The creation progress of the cloud desktop.

100%

ProtocolType

string

The protocol type.

Valid values:

  • HDX :

    HDX protocol.

  • ASP :

    The ASP protocol developed by Alibaba Cloud.

ASP

ReservePoolId

string

The ID of the resource reservation pool associated with the cloud desktop, such as rp-xxx. This parameter is empty if no pool is associated.

rp-xxx

ReservePoolName

string

The name of the resource reservation pool associated with the cloud desktop. This parameter is empty if no pool is associated.

reserve-pool

ResourceGroups

array<object>

The list of enterprise resource groups.

object

The enterprise resource group information.

Id

string

The ID of the enterprise resource group.

rg-4hsvzbbmqdzu3s****

Name

string

The name of the enterprise resource group.

ResourceGroup01

SerialNumber

string

The serial number of the terminal.

96c530bc-6095-4014-8bbc-d461b8ac****

SessionType

string

The session type.

Valid values:

  • SINGLE_SESSION :

    Single session.

  • MULTIPLE_SESSION :

    Multiple sessions.

SINGLE_SESSION

Sessions

array<object>

The user session information of the cloud desktop.

object

The user session information of the cloud desktop.

EndUserId

string

The ID of the user connected to the cloud desktop.

29615820929547****

EstablishmentTime

string

The time when the cloud desktop session was connected. The time follows the ISO 8601 standard in UTC.

2021-03-07T08:23Z

ExternalUserName

string

The name of the external user.

Testname

SnapshotPolicyId

string

The snapshot policy ID.

sp-gi007jgyc3kce****

SnapshotPolicyName

string

The snapshot policy name.

testSnapshotName

StandardStartTime

string

The start time of the query. The time is expressed in the ISO 8601 standard in UTC+0, in the yyyy-mm-ddthh:mm:ssz format.

2025-01-27T02:20:10Z

StartTime

string

The time when the cloud desktop was started for the first time. The time follows the ISO 8601 standard in UTC.

2020-11-06T08:31Z

SubnetId

string

The subnet ID.

vsw-dgea1*****

SubnetName

string

The subnet name of the desktop instance.

VswName

SupportHibernation

boolean

Indicates whether hibernation is supported.

true

SystemDiskCategory

string

Note

This parameter is in invitational preview and is not available.

cloud_auto

SystemDiskSize

integer

Note

This parameter is in invitational preview and is not available.

0

Tags

array<object>

The tag information.

object

The tag information.

Key

string

The tag key.

TestKey

Value

string

The tag value.

TestValue

VolumeEncryptionEnabled

boolean

Indicates whether volume encryption is enabled.

false

VolumeEncryptionKey

string

The ID of the Key Management Service (KMS) key used when volume encryption is enabled. You can obtain the key ID by calling the ListKeys operation.

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****

ZoneId

string

The zone ID.

cn-hangzhou-i

ZoneType

string

The type of the zone. Default value: AvailabilityZone, which indicates a regular availability zone.

AvailabilityZone

NextToken

string

The token that is used to start the next query. If NextToken is empty, no more results exist.

caeba0bbb2be03f84eb48b699f0a4883

PageNumber

integer

The current page number for a paging query.

1

PageSize

integer

The maximum number of entries per page for a paging query.

10

RequestId

string

The request ID.

484256DA-D816-44D2-9D86-B6EE4D5BA78C

TotalCount

integer

The total number of cloud computers.

1

Examples

Success response

JSON format

{
  "Desktops": [
    {
      "AccountType": "SIMPLE",
      "AgentProviderList": [
        "Wuying"
      ],
      "BindAmount": 2,
      "BundleId": "b-2g65ljy4291vl****",
      "BundleName": "TemplateName",
      "ChargeType": "PostPaid",
      "ConnectionStatus": "Disconnected",
      "Cpu": 2,
      "CreationTime": "2020-11-06T08:28Z",
      "DataDiskCategory": "cloud_auto",
      "DataDiskSize": "80",
      "DesktopGroupId": "dg-2i8qxpv6t1a03****",
      "DesktopId": "ecd-gx2x1dhsmucyy****",
      "DesktopName": "DemoComputer01",
      "DesktopStatus": "Running",
      "DesktopType": "ecd.basic.large",
      "DirectoryId": "cn-hangzhou+dir-363353****",
      "DirectoryType": "SIMPLE",
      "Disks": [
        {
          "DiskCategory": "cloud_auto",
          "DiskId": "d-jedbpr4sl9l37****",
          "DiskSize": 80,
          "DiskType": "SYSTEM",
          "PerformanceLevel": "PL0"
        }
      ],
      "DomainType": "AD",
      "DowngradeQuota": 3,
      "DowngradedTimes": 0,
      "EndUserIds": [
        "alice"
      ],
      "EntraDomainName": "contoso.onmicrosoft.com",
      "EnvId": "adifa****",
      "EnvType": "Private",
      "ExpiredTime": "2021-12-31T15:59Z",
      "FotaUpdate": {
        "CurrentAppVersion": "0.0.0-D-20220102.000000",
        "NewAppVersion": "0.0.0-R-20220307.190736",
        "ReleaseNote": "Test upgrade package 03-07",
        "ReleaseNoteEn": "What's new",
        "ReleaseNoteJp": "リリースノート",
        "Size": 108815097
      },
      "GpuCategory": 0,
      "GpuCount": 1,
      "GpuDriverVersion": "471.68",
      "GpuSpec": "NVIDIA T4",
      "HibernationBeta": true,
      "HibernationOptionsConfigured": true,
      "HostName": "testName",
      "ImageId": "m-4zfb6zj728hhr****",
      "ImageName": "Windows server 2019 Mainland",
      "IsLdap": false,
      "ManagementFlag": "NoFlag",
      "ManagementFlags": [
        "[\"NoFlag\"]"
      ],
      "Memory": 4096,
      "NetworkInterfaceId": "123456",
      "NetworkInterfaceIp": "192.168.XX.XX",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "OfficeSiteName": "default",
      "OfficeSiteType": "SIMPLE",
      "OfficeSiteVpcType": "basic",
      "OsType": "Windows",
      "OsUpdate": {
        "CheckId": "ck-8f2a1b****",
        "PackageCount": 3,
        "Packages": [
          {
            "Description": "newDescription",
            "Kb": "KB5032190",
            "Title": "2021-05 Servicing Stack Update for Windows Server 2019 for x64-based Systems (KB5003243)"
          }
        ]
      },
      "Platform": "Ubuntu",
      "PolicyGroupId": "system-all-enabled-policy",
      "PolicyGroupIdList": [
        "pg-dasffjkdf*****"
      ],
      "PolicyGroupName": "All enabled policy",
      "PolicyGroupNameList": [
        "TestPolicy01"
      ],
      "Progress": "100%",
      "ProtocolType": "ASP",
      "ReservePoolId": "rp-xxx",
      "ReservePoolName": "reserve-pool",
      "ResourceGroups": [
        {
          "Id": "rg-4hsvzbbmqdzu3s****",
          "Name": "ResourceGroup01"
        }
      ],
      "SerialNumber": "96c530bc-6095-4014-8bbc-d461b8ac****",
      "SessionType": "SINGLE_SESSION",
      "Sessions": [
        {
          "EndUserId": "29615820929547****",
          "EstablishmentTime": "2021-03-07T08:23Z",
          "ExternalUserName": "Testname"
        }
      ],
      "SnapshotPolicyId": "sp-gi007jgyc3kce****",
      "SnapshotPolicyName": "testSnapshotName",
      "StandardStartTime": "2025-01-27T02:20:10Z",
      "StartTime": "2020-11-06T08:31Z",
      "SubnetId": "vsw-dgea1*****",
      "SubnetName": "VswName",
      "SupportHibernation": true,
      "SystemDiskCategory": "cloud_auto",
      "SystemDiskSize": 0,
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "ZoneId": "cn-hangzhou-i",
      "ZoneType": "AvailabilityZone"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TotalCount": 1
}

Error codes

HTTP status code

Error code

Error message

Description

500 INTERNAL_ERROR Internal error. Internal error.
403 NOT_LOGIN You are not logged in or your login token has expired.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.