Skip to main content

List DPS clusters

GET 

/dwsu/:dwServiceUnitId/dps

Lists DPS clusters in the specified service unit.

Request

Path Parameters

    dwServiceUnitId stringrequired

    The ID of the service unit.

    Example: dw54321

Responses

OK

Schema

    code int32

    The response code.

    data

    object[]

    The wrapped responding data.

  • Array [

  • aqsSpec

    object

    The information about the DPS cluster specification.

    dpuSize int32

    The number of DPUs allocated to the DPS cluster.

    id int64

    The ID of the DPS cluster specification.

    name string

    The name of the DPS cluster specification.

    price object

    The number of credits consumed per unit of time.

    createTime date-time

    The creation time of the DPS cluster.

    creator

    object

    The cloud account information.

    createTimestamp int64

    The creation timestamp of the account.

    domain string

    The domain name assigned to the main account.

    email string

    The email used by the cloud account.

    id string

    The ID of the cloud account.

    isRoot boolean

    Whether the cloud account is a main account.

    roleId string

    The ID of the role to which the cloud account is assigned.

    rootAccountId string

    The ID of the main account.

    status string

    Possible values: [INACTIVE, ACTIVATED, DISABLED]

    The cloud account status.

    description string

    The description of the DPS cluster.

    enableAdaptiveQueryScaling boolean

    Whether Adaptive Query Scaling is enabled.

    enableAutoResume boolean

    Whether Auto Resume is enabled.

    enableAutoSuspend boolean

    Whether Auto Suspend is enabled.

    engine DpsType

    Possible values: [hybrid, extreme]

    The type of the DPS cluster.

    id string

    The ID of the DPS cluster. The value can be Hybrid or Extreme.

    keepAliveTime int32

    The maximum idle time before a DPS cluster is automatically suspended.

    name string

    The name of the DPS cluster.

    owner

    object

    The cloud account information.

    createTimestamp int64

    The creation timestamp of the account.

    domain string

    The domain name assigned to the main account.

    email string

    The email used by the cloud account.

    id string

    The ID of the cloud account.

    isRoot boolean

    Whether the cloud account is a main account.

    roleId string

    The ID of the role to which the cloud account is assigned.

    rootAccountId string

    The ID of the main account.

    status string

    Possible values: [INACTIVE, ACTIVATED, DISABLED]

    The cloud account status.

    spec

    object

    The information about the DPS cluster specification.

    dpuSize int32

    The number of DPUs allocated to the DPS cluster.

    id int64

    The ID of the DPS cluster specification.

    name string

    The name of the DPS cluster specification.

    price object

    The number of credits consumed per unit of time.

    status string

    Possible values: [READY, AUTO, SUSPENDED, PROVISIONING, DROPPING, DROPPED, RESUMING, RESIZING, SUSPENDING, INVALID, LOADING]

    The status of the DPS cluster.

    updateTime date-time

    The last time when the DPS cluster was updated.

  • ]

  • msg string

    The response message.

Loading...