产品概述
基本概念
产品优势
应用场景
Domain name for API request: car.intl.tencentcloudapi.com.
This API is used to create a session. The timeout period of the API is 5 seconds.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateSession. |
| Version | Yes | String | Common Params. The value used for this API: 2022-01-10. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| UserId | Yes | String | Unique user ID, which is customized by you and is not parsed by CAR. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application. |
| UserIp | Yes | String | Public IP address of the user's client, which is used for nearby scheduling. |
| ClientSession | No | String | Client-side session information, which is obtained from the SDK. If RunMode is RunWithoutClient, this parameter can be empty. |
| RunMode | No | String | On-cloud running mode.RunWithoutClient: Keeps the application running on the cloud even when there are no client connections.Empty string (default): Keeps the application running on the cloud only when there are client connections. |
| ApplicationParameters | No | String | Application startup parameters.This parameter is effective for multi-application projects. This parameter is effective for single-application projects with prelaunch disabled.This parameter is ineffective for single-application projects with prelaunch enabled. Note: When this parameter is effective, it will be appended to the startup parameters of application or project configuration in the console. For example, for a single-application project with prelaunch disabled, if its startup parameter bar is 0 for project configuration in the console and the ApplicationParameters parameter foo is 1, the actual application startup parameters will be bar=0 and foo=1. |
| HostUserId | No | String | [Multi-person Interaction] Homeowner's user ID, which is required in multi-person interaction mode. If the user is the homeowner, HostUserID must be the same as UserID. If the user is not the homeowner, HostUserID must be the homeowner's HostUserID. |
| Role | No | String | [Multi-person Interaction] Role. Player: a user who can operate the application via keyboard, mouse, etc. Viewer: a user who can only watch the video in the room but cannot operate the application. |
| Parameter Name | Type | Description |
|---|---|---|
| ServerSession | String | Server-side session information, which is returned to the SDK. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to create a session.
POST / HTTP/1.1
Host: car.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSession
<Common request parameters>
{
"UserIp": "125.127.178.228",
"ClientSession": "eyJhYmMiOjEyM30=",
"UserId": "cg_user"
}{
"Response": {
"ServerSession": "eyJ4dHoiOjc4OX0=",
"RequestId": "fcf4146f-64d3-496c-88dc-d12f832de313"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.LockTimeout | Concurrency quota not requested or request timed out. |
| FailedOperation.PathNotFound | Failed to find the path. |
| FailedOperation.ProcessTimeout | Processing timed out. |
| FailedOperation.SlowDown | The request of the current UserId is being processed. Try again later. |
| InternalError | Internal error. |
| InvalidParameter.JsonParseError | JSON parsing error. |
| InvalidParameterValue | Invalid parameter value. |
| LimitExceeded.Role | [Multi-person Interaction] The number of persons corresponding to a role exceeds the limit. |
| OperationDenied | Operation denied. |
| ResourceNotFound.NoIdle | No available concurrency quota. |
| ResourceNotFound.SessionNotFound | Unable to find the session. |
| ResourceUnavailable.Initialization | It is being initialized. |
| UnsupportedOperation.Stopping | The session is being terminated. |
文档反馈