• Workspace

workspace
  1. Help Center
  2. Workspace
  3. API Reference
  4. Workspace
  5. Querying Workspace Details

Querying Workspace Details

Function

This interface is used to query Workspace details.

URI

  • URI format

    GET /v1.0/{project_id}/workspaces

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    string

    Specifies the user ID.

Request

  • Request example
GET /v1.0/29dfe82ada564ac2b927e1ff036d9a9b/workspaces

Response

  • Description

    Name

    Type

    Description

    ad_domains

    Dictionary data structure [1]

    Specifies the domain information used by Workspace.

    vpc_id

    string

    Specifies the unique VPC ID.

    vpc_name

    string

    Specifies the VPC name.

    dedicated_access_address

    string

    Specifies the DirectConnect access address. This parameter has a value when the access mode is DEDICATED or BOTH.

    internet_access_address

    string

    Specifies the Internet access address.

    status

    string

    Specifies the Workspace status. Possible values are:

    • PREPARING: indicates that Workspace is in the process of preparation for the subscription.
    • SUBSCRIBING: indicates that Workspace is being subscribed.
    • SUBSCRIBED: indicates that Workspace has been subscribed.
    • SUBSCRIPTION_FAILED: indicates that the subscription has failed.
    • DEREGISTERING: indicates that the account is being deregistered.
    • DEREGISTRATION_FAILED: indicates that the deregistration has failed.

    access_mode

    string

    Specifies the access mode. Possible values are:

    • INTERNET: indicates the Internet access mode.
    • DEDICATED: indicates the DirectConnect access mode.
    • BOTH: indicates both modes.

    subnet_ids

    List data structure [2]

    Specifies the subnet ID.

[1] ad_domains field data structure description

Name

Type

Description

domain_type

string

Specifies the domain type. Possible values are:

  • LITE_AD: indicates the lightweight AD that is deployed on the cloud.
  • LOCAL_AD: indicates the local AD, namely, the user's existing AD.

domain_name

string

Specifies the domain name.

domain_admin_account

string

Specifies the domain administrator account.

active_domain_ip

string

Specifies the IP address of the active domain controller. This parameter has a value when the domain type is LOCAL_AD.

standby_domain_ip

string

Specifies the IP address of the standby domain controller. This parameter has a value when the domain type is LOCAL_AD.

active_dns_ip

string

Specifies the IP address of the active DNS. This parameter has a value when the domain type is LOCAL_AD.

standby_dns_ip

string

Specifies the IP address of the standby DNS. This parameter has a value when the domain type is LOCAL_AD.

[2] subnet_ids field data structure description

Name

Type

Description

subnet_id

string

Specifies the subnet ID.

  • Response example
    When the domain type is LITE_AD:
    {
      "ad_domains": {
        "domain_type": "LITE_AD",
        "domain_name": "test.com",
        "domain_admin_account": "vdsadmin",
        "active_domain_ip": null,
        "standby_domain_ip": null,
        "active_dns_ip": null,
        "standby_dns_ip": null
      },
      "vpc_id": "dbecb512-34d1-4d7d-90f1-6d3feb76263d",
      "vpc_name": "test",
      "dedicated_access_address": "https://192.168.0.4",
      "internet_access_address": "https://10.154.55.185",
      "status": "SUBSCRIBED",
      "access_mode": "DEDICATED",
      "subnet_ids": [
        {
          "subnet_id": "a4bde8e5-b8b7-453c-839b-3c5a3a49772f"
        }
      ]
    }
    When the domain type is LOCAL_AD:
    {
      "ad_domains": {
        "domain_type": "LOCAL_AD",
        "domain_name": "test.com",
        "domain_admin_account": "vdsadmin",
        "active_domain_ip": "172.16.0.4",
        "standby_domain_ip": "172.16.0.5",
        "active_dns_ip": "172.16.0.4",
        "standby_dns_ip": "172.16.0.5"
      },
      "vpc_id": "dbecb512-34d1-4d7d-90f1-6d3feb76263d",
      "vpc_name": "test",
      "dedicated_access_address": "null",
      "internet_access_address": "https://10.154.55.185",
      "status": "SUBSCRIBED",
      "access_mode": "INTERNET",
      "subnet_ids": [
        {
          "subnet_id": "a4bde8e5-b8b7-453c-839b-3c5a3a49772f"
        }
      ]
    }

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The request syntax is incorrect and cannot be understood by the server.

    401 Unauthorized

    Authentication fails.

    403 Forbidden

    You are not authorized to perform the operation.

    404 Not Found

    The requested resource is not found.

    405 Method Not Allowed

    The method specified in the request is not allowed.

    500 Internal Server Error

    Internal service error. For details about error codes, see Error Code Description.

    503 Service Unavailable

    The service is unavailable.