Updated on 2025-12-16 GMT+08:00

Obtaining the Tenant Version

Function

This API is used to query the current version details of a tenant.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/tenant-version/detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

tenant_id

Yes

String

Definition:

Tenant ID, that is, domain ID of a user.

Constraints:

N/A

Value range:

The value consists of 32 characters, including only digits and letters.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

region

String

Definition:

Region.

Value range:

N/A

version

String

Definition:

Pipeline version.

Value range:

N/A

domain_id

String

Definition:

Tenant ID.

Value range:

32 characters.

ui_version

String

Definition:

UI version.

Value range:

N/A

gray_end

Boolean

Definition:

Whether the gray release is complete.

Value range:

  • true: completed.

  • false: not completed.

end_time

String

Definition:

Gray release completion time.

Value range:

Date format.

end_time_hint

String

Definition:

Completion time prompt.

Value range:

Date format.

Example Requests

GET https://{endpoint}/v5/ce8df55870164338a72d7e828a966a2a/api/tenant-version/detail?_=1763887109466

Example Responses

Status code: 200

OK

{
  "region" : "cn-north-7",
  "version" : "3.0",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "ui_version" : "3.0",
  "gray_end" : false,
  "end_time" : "2026-05-01",
  "end_time_hint" : "2026-04-01"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.