{"componentChunkName":"component---src-templates-acg-portal-intl-template-tsx","path":"/fmt6xifyu","result":{"data":{"markdownRemark":{"html":"\n
\n
\n
\n
\n
POST
\n
\nhttps://api.baiduqianfan.ai/v2/overseas/team/tokenplan?Action=DescribeSeats\n
\n
\n
\n

Call this API to query the seat list under the master account. Filtering by sub-user, plan resource, plan type, and seat state is supported, as well as pagination.

\n
\n
\n

Authentication

\n

This API requires API Key authentication. Log in to the Baidu AI Cloud Console to obtain your API Key:

\n\n

Keep your API Key secure. Do not share it publicly or commit it to code repositories.

\n
\n
\n

Request Parameters

\n
\n
\n
\n
\n
Headers
\n
No additional special headers except common headers
\n
\n
\n
\n
\n
Body
\n
\n
\n
\n
\n
\n\ncloudIds\n\narray\n
\n

Filters by sub-user cloudId. Pass an empty array or omit this field to disable this filter.

\n
\n
Optional
\n
\n\n
\n\nShow Sub-properties\nHide Sub-properties\n
\n\n
\n
\n
\n\nitems\n\nstring\n
\n
\n
\n
\n
\n
\n
\n
\n\ntpResourceIds\n\narray\n
\n

Filters by plan resource ID. A plan resource ID is a string prefixed with tps-.

\n
\n
Optional
\n
\n\n
\n\nShow Sub-properties\nHide Sub-properties\n
\n\n
\n
\n
\n\nitems\n\nstring\n
\n
\n
\n
\n
\n
\n
\n
\n\nplanType\n\narray\n
\n

Filters by plan type. Valid values: lite, pro, max, ultra.

\n
\n
Optional
\n
\n\n
\n\nShow Sub-properties\nHide Sub-properties\n
\n\n
\n
\n
\n\nitems\n\nstring\n
\n
\n
\n
\n
\n
\n
\n
\n\nseatState\n\narray\n
\n

Filters by seat state.
0: Unallocated.
1: In use.
2: Expired.
3: Deactivated.
If omitted, seats with states 0/1/2 are returned by default (state 3 is excluded).

\n
\n
Optional
\n
\n\n
\n\nShow Sub-properties\nHide Sub-properties\n
\n\n
\n
\n
\n\nitems\n\ninteger\n
\n
\n
\n
\n
\n
\n
\n
\n\npageNo\n\ninteger\n
\n

The page number, starting from 1.

\n
\n
Optional
\n
\n
\n
\n\npageSize\n\ninteger\n
\n

The number of items per page.

\n
\n
Optional
\n
\n
\n
\n
\n
\n
\n
\n
\n
Request Structure
\n\n
\n
\n\n
\n
POST /v2/overseas/team/tokenplan?Action=DescribeSeats HTTP/1.1\nHost: api.baiduqianfan.ai\nAuthorization: Bearer <API Key>\nContent-Type: application/json\n\n{\n  \"cloudIds\": [],\n  \"pageNo\": 1,\n  \"pageSize\": 10\n}
\n
\n
\n
\n
\n
\n
\n
\n

Sample Code

\n
\n\n
\n
\n
\n
请求示例
\n\n
\n
\n\n
\n
curl -X POST 'https://api.baiduqianfan.ai/v2/overseas/team/tokenplan?Action=DescribeSeats' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: Bearer <API Key>' \\\n -d '{\n  \"cloudIds\": [],\n  \"pageNo\": 1,\n  \"pageSize\": 10\n}'
\n
\n
\n
\n
\n
\n
\n
\n

Response

\n
\n
\n
\n
\n
Headers
\n
No additional special headers except common headers
\n
\n
\n
\n
\n
Response Parameters
\n
\n
\n
\n
\n
\n\nrequestId\n\nstring\n
\n

The request ID in UUID format, used for troubleshooting.

\n
\n
Optional
\n
\n
\n
\n\nresult\n\nobject {2}\n
\n

The business data object.

\n
\n
Optional
\n
\n\n
\n\nShow Sub-properties\nHide Sub-properties\n
\n\n
\n
\n
\n\ntotal\n\ninteger\n
\n

The total number of items.

\n
\n
Optional
\n
\n
\n
\n\nitems\n\narray\n
\n

The seat list.

\n
\n
Optional
\n
\n\n
\n\nShow Sub-properties\nHide Sub-properties\n
\n\n
\n
\n
\n\nitems\n\nobject {11}\n
\n
\n
\n\n
\n\nShow Sub-properties\nHide Sub-properties\n
\n\n
\n
\n
\n\nseatId\n\nstring\n
\n

The seat ID.

\n
\n
Optional
\n
\n
\n
\n\nplanType\n\nstring\n
\n

The plan type: lite, pro, max, ultra.

\n
\n
Optional
\n
\n
\n
\n\nseatState\n\ninteger\n
\n

The seat state.
0: Unallocated.
1: In use.
2: Expired.
3: Deactivated.

\n
\n
Optional
\n
\n
\n
\n\ntpResourceId\n\nstring\n
\n

The ID of the plan resource the seat belongs to, a string prefixed with tps-.

\n
\n
Optional
\n
\n
\n
\n\ncloudId\n\nstring\n
\n

The cloudId of the bound member. An empty string if the seat is unallocated (seatState is 0).

\n
\n
Optional
\n
\n
\n
\n\nmemberName\n\nstring\n
\n

The login name of the bound member. An empty string if the seat is unallocated.

\n
\n
Optional
\n
\n
\n
\n\nbindTime\n\nstring\n
\n

The binding time, in yyyy-MM-dd HH:mm:ss format. An empty string if the seat is unallocated.

\n
\n
Optional
\n
\n
\n
\n\nsubscribeStart\n\nstring\n
\n

The subscription start time.

\n
\n
Optional
\n
\n
\n
\n\nsubscribeEnd\n\nstring\n
\n

The subscription end time.

\n
\n
Optional
\n
\n
\n
\n\nseatCreditsTotal\n\nstring\n
\n

The total credits of the seat, a DECIMAL string with two decimal places (e.g., 20000.00). Passed through as-is to avoid precision loss; process it as a string.

\n
\n
Optional
\n
\n
\n
\n\nseatCreditsUsed\n\nstring\n
\n

The used credits of the seat, a DECIMAL string with two decimal places (e.g., 0.00). Passed through as-is to avoid precision loss; process it as a string.

\n
\n
Optional
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n\n
\n
\n
\n
响应示例
\n\n
\n
\n\n
\n
{\n  \"requestId\": \"98186cde-f322-4022-be90-0d944555bcee\",\n  \"result\": {\n    \"total\": 2,\n    \"items\": [\n      {\n        \"seatId\": \"tpst-w25ysj7mghkt\",\n        \"planType\": \"lite\",\n        \"seatState\": 1,\n        \"memberName\": \"fluxa_f1_e2e_user\"\n      },\n      {\n        \"seatId\": \"tpst-f77gwdgksmri\",\n        \"planType\": \"lite\",\n        \"seatState\": 0,\n        \"memberName\": \"\"\n      }\n    ]\n  }\n}
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Error Codes

\n

If a request fails, the server will return a JSON object with a code field identifying the error.

\n

Common Error Codes for This API

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
ParamErrorFailed to parse or validate request parameters.
\n

Complete Error Code Reference

\n

The table below lists all possible values of the code field returned by TokenPlan APIs. The common error codes of each API are a subset of this list.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeHTTP Status CodeDescription
ParamError400Failed to parse or validate request parameters.
ParamValueError400Invalid parameter value.
RateLimitExceeded429Too many concurrent requests; rate limiting triggered.
TokenPlanSeatNotFound400The seat does not exist.
TokenPlanSeatNoPermission400No permission to operate on this seat.
TokenPlanSeatNotAvailable400The seat is not in an operable state (deactivated, expired, or modified by a concurrent operation).
TokenPlanSeatMemberMismatch400The member bound to the seat does not match the request.
TokenPlanMemberNotFound400The member does not exist.
TokenPlanMemberNoPermission400No permission to operate on this member.
TokenPlanParamDuplicated400The request contains duplicate items (e.g., seatId).
TokenPlanApiKeyRespError500The API Key service returned an error.
TokenPlanApiKeyRespNull500The API Key service returned an empty response.
TokenPlanApiKeyIsEmpty500The API Key is an empty string.
TokenPlanMemberListError500An error occurred while querying the member list.
TokenPlanIamQuerySubusersWithContactError500An error occurred while querying sub-user information from IAM.
TokenPlanResourceNotFound400The plan resource does not exist.
TokenPlanResourceAlreadyExists400The plan resource already exists and cannot be purchased again.
TokenPlanResourceNotAvailable400The plan resource has been unsubscribed or has expired and cannot be operated on.
TokenPlanSeatPlanMismatch400The seat's plan type does not match the request.
TokenPlanSeatPlanNotUpgradable400The seat's plan type does not support upgrades.
TokenPlanLogNoAction400Unsupported log action.
TokenPlanLogParseTimeError500An error occurred while parsing the log time.
TokenPlanLimitAdminError500The limitServer service encountered an error.
TokenPlanMysqlMemberError500An error occurred while querying member data.
TokenPlanDomainHasActivePlan400The master account already has an active plan and cannot purchase another one.
TokenPlanMemberAlreadyBound400The member is already bound to a seat under the current plan and cannot be bound again.
TokenPlanSeatResourceMismatch400Seats bound in the same batch must belong to the same plan.
TokenPlanChooseAndBindError500An error occurred while adding a member from an existing sub-user.
TokenPlanCreateAndBindError400An error occurred while creating the sub-user or adding the member.
\n
\n
","fields":{"slug":"fmt6xifyu","title":"describe-seats","date":"2026-08-24","extractedHeadings":[{"value":"Authentication","depth":2},{"value":"Request Parameters","depth":2},{"value":"Sample Code","depth":2},{"value":"Response","depth":2},{"value":"Error Codes","depth":2}]},"headings":[]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"slug":"fmt6xifyu","prev":{"id":"amtaz2wj2","name":"describe-seat-list","path":"amtaz2wj2","filePath":"4.API Reference/management/describe-seat-list.md","seo":null,"parentIds":["lmn5zc6ps","dmt2re9rp"],"parents":[{"id":"lmn5zc6ps","documentId":"142a1f66-b0e9-4834-950a-9b9ceefbd3d5","name":"API Reference","repoName":"qianfan","filePath":"4.API Reference","disabled":false,"path":"lmn5zc6ps","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":{"title":null,"keywords":null,"description":null,"serviceType":null},"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"dmt2re9rp","documentId":"35b21a86-848e-43e7-8ad1-ace59dd5f70e","name":"management","repoName":"qianfan","filePath":"4.API Reference/management","disabled":false,"path":"dmt2re9rp","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}]},"next":{"id":"Lmt6u8kfb","name":"create-member-and-bind-seat","path":"Lmt6u8kfb","filePath":"4.API Reference/management/create-member-and-bind-seat.md","seo":null,"parentIds":["lmn5zc6ps","dmt2re9rp"],"parents":[{"id":"lmn5zc6ps","documentId":"142a1f66-b0e9-4834-950a-9b9ceefbd3d5","name":"API Reference","repoName":"qianfan","filePath":"4.API Reference","disabled":false,"path":"lmn5zc6ps","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":{"title":null,"keywords":null,"description":null,"serviceType":null},"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"dmt2re9rp","documentId":"35b21a86-848e-43e7-8ad1-ace59dd5f70e","name":"management","repoName":"qianfan","filePath":"4.API Reference/management","disabled":false,"path":"dmt2re9rp","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}]},"parents":[{"id":"lmn5zc6ps","documentId":"142a1f66-b0e9-4834-950a-9b9ceefbd3d5","name":"API Reference","repoName":"qianfan","filePath":"4.API Reference","disabled":false,"path":"lmn5zc6ps","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":{"title":null,"keywords":null,"description":null,"serviceType":null},"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null},{"id":"dmt2re9rp","documentId":"35b21a86-848e-43e7-8ad1-ace59dd5f70e","name":"management","repoName":"qianfan","filePath":"4.API Reference/management","disabled":false,"path":"dmt2re9rp","lastMergeTime":null,"isApiDoc":null,"httpMethod":null,"seo":null,"sourceOrgName":null,"sourceRepoName":null,"sourceDocumentId":"","solutionTag":null,"solutionColor":null}],"specificSeo":null}}}