Help Center/ KooDrive/ API Reference/ API/ Service Subscription/ Obtaining the Subscription Status

Updated on 2024-07-30 GMT+08:00

View PDF

Obtaining the Subscription Status

Function

Obtain the subscription status of the management console service.

URI

GET /koodrive/ose/v1/service

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Authorization	Yes	String	Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.
language	No	String	Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
code	String	Response code.
msg	String	Response message.
data	ServiceStatus object	Cloud service subscription status.

**Table 3** ServiceStatus
Parameter	Type	Description
status	Integer	Service status. 0: normal (The cloud service restores, for example, after being unfrozen.) 1: frozen (Resources and data are reserved but the cloud service cannot be used.)
spaceCapacity	Integer	Space quota.
userCount	Integer	OrgID user quota.
groupSpaceSize	Integer	Default size of the team space. 0 indicates that no space is enabled.
personalSpaceSize	Integer	Default size of the individual space. 0 indicates that no space is enabled.
organizationName	String	Organization name.
organizationId	String	Organization ID.
rootDeptCode	String	Root department code generated after the organization is created in OrgID.
tenantId	String	Tenant ID.
departmentSpaceSize	String	Default size of the department space. 0 indicates that no space is enabled.
aiAvailable	String	Whether AI is enabled.
wpsAvailable	String	Whether WPS is enabled.
productType	String	Product type.

Example Requests

Request for obtaining the subscription status of the management console service.

GET /koodrive/ose/v1/service

Authorization:Bearer+10f88d***************4791e9ff

Example Responses

Status code: 200

Service status.

{
  "data": {
    "tenantId": "40086000004871666",
    "status": 0,
    "spaceCapacity": 10000,
    "userCount": 7000,
    "personalSpaceSize": 0,
    "groupSpaceSize": 10,
    "organizationName": "KooDrive",
    "organizationId": "9190086000001210958",
    "rootDeptCode": "aed8a3763f9b4177beb2dd8bce1a3885",
    "departmentSpaceSize":0
    "productType":"2"
    "wpsAvailable":true
    "aiAvailable": true
  },
  "code": 0,
  "msg": "Successful"
}