Get service unit

GET 
/unit

Gets information about the service unit.

Request

Responses

200

OK

application/json

Schema

Schema

code int32

The response code.

data

object

The information about the service unit.

alias string

The alias of the service unit.

createTimestamp date-time

The creation timestamp of the service unit.

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.

defaultDps

object

The DPS cluster information.

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.

domain string

The domain name of the service unit.

edition

object

The edition information of the service unit.

description string

The description of the edition.

features

object[]

The list of features supported by the edition.

Array [

description string

The description of the feature.

id string

The ID of the feature.

name string

The name of the feature.

]

id string

The ID of the edition.

isAvailable boolean

Whether the edition is available.

name string

The name of the edition.

endpoints

object[]

The list of endpoints that can be used to connect to the service unit.

Array [

host string

The name of the host used by the endpoint.

id string

The ID of the endpoint.

port int32

The port number used by the endpoint.

protocol string

Possible values: [HTTP, HTTPS, JDBC]

The protocol used by the endpoint.

type string

Possible values: [openapi, web_console, database]

The type of the endpoint.

uri string

The URI of the endpoint.

]

id string

The ID of the service unit.

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.

region

object

The region information.

area string

The location of the region.

cloud

object

The cloud provider information.

id string

The ID of the cloud provider.

isAvailable boolean

Whether the cloud provider is a public cloud provider.

isPublic boolean

Whether the cloud provider is a public cloud provider.

link string

The URL of the cloud provider.

name string

The name of the cloud provider.

id string

The ID of the region.

name string

The name of the region.

public boolean

regionInfo

object

The region information.

info object

The region information.

status string

Possible values: [PROVISIONING, PROVISIONING_FAILED, READY, DROPPING]

The status of the service unit.

tags string[]

The tags of the service unit.

updateTimestamp date-time

The last update timestamp of the service unit.

msg string

The response message.

Example (from schema)

{
  "code": 0,
  "data": {
    "alias": "string",
    "createTimestamp": "2024-01-11T11:03:20.786Z",
    "creator": {
      "createTimestamp": 1685510869834,
      "domain": "string",
      "email": "[email protected]",
      "id": "account-100001",
      "isRoot": true,
      "roleId": "role-100001",
      "rootAccountId": "rootAccount-100002",
      "status": "INACTIVE"
    },
    "defaultDps": {
      "aqsSpec": {
        "dpuSize": 0,
        "id": 0,
        "name": "string",
        "price": {}
      },
      "createTime": "2023-05-18T14:20:11.01+09:00",
      "creator": {
        "createTimestamp": 1685510869834,
        "domain": "string",
        "email": "[email protected]",
        "id": "account-100001",
        "isRoot": true,
        "roleId": "role-100001",
        "rootAccountId": "rootAccount-100002",
        "status": "INACTIVE"
      },
      "description": "string",
      "enableAdaptiveQueryScaling": true,
      "enableAutoResume": true,
      "enableAutoSuspend": true,
      "engine": "hybrid",
      "id": "string",
      "keepAliveTime": 0,
      "name": "string",
      "owner": {
        "createTimestamp": 1685510869834,
        "domain": "string",
        "email": "[email protected]",
        "id": "account-100001",
        "isRoot": true,
        "roleId": "role-100001",
        "rootAccountId": "rootAccount-100002",
        "status": "INACTIVE"
      },
      "spec": {
        "dpuSize": 0,
        "id": 0,
        "name": "string",
        "price": {}
      },
      "status": "READY",
      "updateTime": "2023-05-18T14:20:11.01+09:00"
    },
    "domain": "string",
    "edition": {
      "description": "string",
      "features": [
        {
          "description": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "id": "string",
      "isAvailable": true,
      "name": "string"
    },
    "endpoints": [
      {
        "host": "string",
        "id": "string",
        "port": 0,
        "protocol": "HTTP",
        "type": "openapi",
        "uri": "string"
      }
    ],
    "id": "string",
    "owner": {
      "createTimestamp": 1685510869834,
      "domain": "string",
      "email": "[email protected]",
      "id": "account-100001",
      "isRoot": true,
      "roleId": "role-100001",
      "rootAccountId": "rootAccount-100002",
      "status": "INACTIVE"
    },
    "region": {
      "area": "Singapore",
      "cloud": {
        "id": "string",
        "isAvailable": true,
        "isPublic": true,
        "link": "string",
        "name": "string"
      },
      "id": "string",
      "name": "string",
      "public": true,
      "regionInfo": {
        "info": {}
      }
    },
    "status": "PROVISIONING",
    "tags": [
      "string"
    ],
    "updateTimestamp": "2024-01-11T11:03:20.787Z"
  },
  "msg": "string"
}

Loading...