Help Center/ Media Processing Center/ API Reference/ Tenant Subscription/ Querying Service Subscription Status as a Tenant
Updated on 2024-03-14 GMT+08:00

Querying Service Subscription Status as a Tenant

Function

This API is used by a tenant to query the subscription status of the media transcoding service.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/tenant/access

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining the Project ID](tag:hc,hk).

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

is_open

Boolean

Whether the service has been subscribed to

  • false: no

  • true: yes

agreement_version

Integer

Service agreement version.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

None

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "is_open" : false,
  "agreement_version" : 1
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeded.

400

The information is returned when the request failed.

Error Codes

See Error Codes.