tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateApplicationProject

Last updated: 2024-09-14 10:44:56

1. API Description

Domain name for API request: car.tencentcloudapi.com.

This API is used to create a cloud application project.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreateApplicationProject.
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.
Name Yes String Project name, which is user-defined.
ApplicationId Yes String Bound application ID.
Type Yes String Concurrency type required for project operation.S1: concurrency for rendering small cloud applications.M1: concurrency for rendering medium cloud applications.L1: concurrency for rendering large cloud applications.L2: concurrency for rendering large cloud applications.XL2: concurrency for rendering extra large cloud applications.MM1_HD: concurrency for performance-based cloud ARM (HD).MM1_FHD: concurrency for performance-based cloud ARM (FHD).
IsPreload No Boolean Whether to enable warm-up. The default value is false.
ApplicationParams No String Application startup parameters.
Resolution No String Resolution, in the format of widthxheight, such as 1920x1080.
ProjectType No String Project type.SHARED: shared by all applications.EXCLUSIVE (default value): dedicated for one application.
FPS No Integer Frame rate.
PreloadDuration No String Waiting time for application pre-launch.
ReconnectTimeout No String Waiting time for reconnection.
MinBitrate No Integer Minimum bitrate, in Mbps.
MaxBitrate No Integer Maximum bitrate, in Mbps.
UpstreamAudioOption No String Upstream audio options.DisableMixIntoStreamPush: not mixing upstream audio in streaming.
VideoEncodeConfig No VideoEncodeConfig Video encoding configuration.
XRMaxWidth No Integer Upper limit of the XR application resolution.If the project concurrency type is L or L2, the upper limit is 5000; if the project concurrency type is XL2, the upper limit is 6000.
BackgroundImageCOSFileId No String ID of the background image COS file.
ProjectCategory No String Project category.DESKTOP: desktop (default value).MOBILE: mobile.
DisableVideoCodecs.N No Array of String Disabled code list.

3. Output Parameters

Parameter Name Type Description
ProjectId String Generated project ID.Note: This field may return null, indicating that no valid values can be obtained.
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.

4. Example

Example1 Creating a Cloud Application Project

This example shows you how to create a cloud application project.

Input Example

POST / HTTP/1.1
Host: car.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApplicationProject
<Common request parameters>



{
    "Name": "abc",
    "ApplicationId": "abc",
    "Type": "abc",
    "IsPreload": true,
    "ApplicationParams": "abc",
    "Resolution": "abc",
    "ProjectType": "abc",
    "FPS": 0,
    "PreloadDuration": "10s",
    "ReconnectTimeout": "20s",
    "MinBitrate": 0,
    "MaxBitrate": 10,
    "DisableVideoCodecs": []
}

Output Example

{
    "Response": {
        "ProjectId": "abc",
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy