Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Determining Whether the Tenant's Account Should Be Frozen Based on the Tenant's Subscription Status
Updated on 2025-11-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Determining Whether the Tenant's Account Should Be Frozen Based on the Tenant's Subscription Status

Function

This API is used to determine whether the tenant's account should be frozen based on the tenant's subscription status.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/package-specs/is-freeze

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

tenant_id

Yes

String

Definition:

Tenant ID.

Constraints:

N/A

Value range:

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

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

projectDomainName

String

Definition:

Name of the tenant to which the project belongs.

Value range:

N/A

currentDomainName

String

Definition:

Tenant name of the current account.

Value range:

N/A

packageName

String

Definition:

Package name.

Value range:

N/A

freezeType

String

Definition:

Frozen status.

Value range:

N/A

freeze

Boolean

Definition:

Whether the account is frozen.

Value range:

  • true: frozen.

  • false: not frozen.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "projectDomainName" : "domain",
  "currentDomainName" : "domain",
  "packageName" : null,
  "freezeType" : null,
  "freeze" : false
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Pipeline Management