- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- Practical Tutorial
- SDK Documentation
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- User APIs
- Application Management APIs
- CreateApplication
- CreateApplicationSnapshot
- CreateApplicationVersion
- DeleteApplication
- DeleteApplicationVersion
- DescribeApplicationList
- DescribeApplicationPathList
- DescribeApplicationStatus
- DescribeApplicationVersion
- DescribeCosCredential
- ModifyApplicationBaseInfo
- ModifyApplicationVersion
- SetApplicationVersionOnline
- DescribeApplicationFileInfo
- ModifyMobileApplicationInfo
- Project Management APIs
- Concurrency Management APIs
- Stream Push Service APIs
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- CAR Policy
- Contact Us
- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started
- Console Guide
- Practical Tutorial
- SDK Documentation
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- User APIs
- Application Management APIs
- CreateApplication
- CreateApplicationSnapshot
- CreateApplicationVersion
- DeleteApplication
- DeleteApplicationVersion
- DescribeApplicationList
- DescribeApplicationPathList
- DescribeApplicationStatus
- DescribeApplicationVersion
- DescribeCosCredential
- ModifyApplicationBaseInfo
- ModifyApplicationVersion
- SetApplicationVersionOnline
- DescribeApplicationFileInfo
- ModifyMobileApplicationInfo
- Project Management APIs
- Concurrency Management APIs
- Stream Push Service APIs
- Data Types
- Error Codes
- FAQs
- Service Level Agreement
- CAR Policy
- Contact Us
ApplicationBaseInfo
Application basic data.
Used by actions: DescribeApplicationList, ModifyApplicationBaseInfo.
| Name | Type | Required | Description |
|---|---|---|---|
| WindowUseType | String | Yes | Application window usage mode (ApplicationDesktop: Captures the entire desktop; ApplicationWindow: Captures only the application window). |
| WindowName | String | No | Application window name. |
| WindowClassName | String | No | Application window class name. |
| WindowCaptureMode | String | No | Application window capture mode (HOOK: default mode; DDA_CUT: compatible mode). |
ApplicationConcurrentPackage
Cloud application concurrency packs.
Used by actions: DescribeConcurrentPackages.
| Name | Type | Required | Description |
|---|
ApplicationProject
Cloud application project type.
Used by actions: DescribeApplicationProjects.
| Name | Type | Required | Description |
|---|---|---|---|
| ProjectId | String | No | Project ID.Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | No | Project name.Note: This field may return null, indicating that no valid values can be obtained. |
| Description | String | No | Project description.Note: This field may return null, indicating that no valid values can be obtained. |
| Type | String | No | 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).Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationId | String | No | Cloud application ID.Note: This field may return null, indicating that no valid values can be obtained. |
| IsPreload | Boolean | No | Pre-launch.Note: This field may return null, indicating that no valid values can be obtained. |
| Amount | Integer | No | Number of concurrencies already configured.Note: This field may return null, indicating that no valid values can be obtained. |
| Using | Integer | No | Number of concurrencies in use.Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationStatus | String | No | Application status. NoConcurrent: no concurrency pack configured; Online: activated. Cloud application status: applicationCreating: creating; applicationCreateFail: creation failed; applicationDeleting: deleting; applicationNoConfigured: startup parameters not configured.Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationParams | String | No | Application startup parameters. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | No | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationName | String | No | Application name. Note: This field may return null, indicating that no valid values can be obtained. |
| Resolution | String | No | Resolution, in the format of widthxheight, such as 1920x1080.Note: This field may return null, indicating that no valid values can be obtained. |
| ProjectType | String | No | Project type.SHARED: shared by all applications.EXCLUSIVE (default value): dedicated for one application.Note: This field may return null, indicating that no valid values can be obtained. |
| Purpose | String | No | Purpose.EXPERIENCE: Experience.Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationRegions | Array of String | No | Application distribution area. Standard areas are as follows. ap-chinese-mainland: Chinese mainland; na-north-america: North America; eu-frankfurt: Frankfurt; ap-mumbai: Mumbai; ap-tokyo: Tokyo; ap-seoul: Seoul; ap-singapore: Singapore; ap-bangkok: Bangkok; ap-hongkong: Hong Kong (China). Fusion areas are as follows. me-middle-east-fusion: Middle East; na-north-america-fusion: North America; sa-south-america-fusion: South America; ap-tokyo-fusion: Tokyo; ap-seoul-fusion: Seoul; eu-frankfurt-fusion: Frankfurt; ap-singapore-fusion: Singapore; ap-hongkong-fusion: Hong Kong (China).Note: This field may return null, indicating that no valid values can be obtained. |
| ConcurrentRegions | Array of String | No | Concurrency area. Standard areas are as follows. ap-chinese-mainland: Chinese mainland; na-north-america: North America; eu-frankfurt: Frankfurt; ap-mumbai: Mumbai; ap-tokyo: Tokyo; ap-seoul: Seoul; ap-singapore: Singapore; ap-bangkok: Bangkok; ap-hongkong: Hong Kong (China). Fusion areas are as follows. me-middle-east-fusion: Middle East; na-north-america-fusion: North America; sa-south-america-fusion: South America; ap-tokyo-fusion: Tokyo; ap-seoul-fusion: Seoul; eu-frankfurt-fusion: Frankfurt; ap-singapore-fusion: Singapore; ap-hongkong-fusion: Hong Kong (China).Note: This field may return null, indicating that no valid values can be obtained. |
| ProjectCategory | String | No | Project category.DESKTOP: desktop (default value).MOBILE: mobile.Note: This field may return null, indicating that no valid values can be obtained. |
BackgroundImage
Background image information.
Used by actions: DescribeApplicationProjectAdvancedConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| COSFileId | String | No | ID of the COS file.Note: This field may return null, indicating that no valid values can be obtained. |
| URL | String | No | Download URL.Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | No | Name Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | No | Creation time. Note: This field may return null, indicating that no valid values can be obtained. |
Filter
Query filter criteria.
Used by actions: DescribeApplicationList, DescribeApplicationProjects, DescribeConcurrentPackages.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Filter field name (ApplicationId: application ID; ApplicationName: application name; ApplicationRunStatus: running status; ApplicationUpdateStatus: update status). |
| Values | Array of String | Yes | Filter value set (When the filter name is ApplicationRunStatus, the values can be [ApplicationDeleting: application deletion in progress; ApplicationCreateFail: application creation failed; ApplicationCreating: application creation in progress; ApplicationRunning: normal running; ApplicationNoConfigured: main execution program path not configured]. When the filter name is ApplicationUpdateStatus, the values can be [ApplicationUpdateCreating: version creation in progress; ApplicationUpdateCreateFail: version creation failed; ApplicationUpdateNoReleased: version to be released; ApplicationUpdateReleased: version release completed; ApplicationUpdateNormal: none]). |
UserApplicationFileInfo
Application file information.
Used by actions: DescribeApplicationFileInfo.
| Name | Type | Description |
|---|---|---|
| FilePath | String | Application file path. Note: This field may return null, indicating that no valid values can be obtained. |
| FileState | String | File status. NO_EXIST: The file does not exist; EXIST: The file exists. Note: This field may return null, indicating that no valid values can be obtained. |
UserApplicationInfo
Application data information.
Used by actions: DescribeApplicationList.
| Name | Type | Description |
|---|---|---|
| ApplicationId | String | Application ID. |
| ApplicationName | String | Application name. |
| ApplicationType | String | Application type (cloud 3D: Application3D; cloud XR: ApplicationXR; cloud Web: ApplicationWeb). |
| ApplicationExePath | String | Application program execution path. |
| ApplicationInterList | String | Application process list. |
| ApplicationParams | String | Application startup parameters. |
| ApplicationRunStatus | String | Application running status (ApplicationDeleting: application deletion in progress; ApplicationCreateFail: application creation failed; ApplicationCreating: application creation in progress; ApplicationRunning: normal running; ApplicationNoConfigured: main execution program path not configured). |
| ApplicationUpdateStatus | String | Application update status (ApplicationUpdateCreating: version creation in progress; ApplicationUpdateCreateFail: version creation failed; ApplicationUpdateNoReleased: version to be released; ApplicationUpdateReleased: version release completed; ApplicationUpdateNormal: none). |
| ApplicationCreateTime | Timestamp ISO8601 | Application creation time. |
| ApplicationVersions | Array of UserApplicationVersion | List of application versions. |
| ApplicationBaseInfo | ApplicationBaseInfo | Application basic data. |
| ApplicationUpdateProgress | Integer | Application update progress. |
| ApplicationNature | String | Application nature (PUBLIC: public application; PRIVATE: user application). |
| ApplicationStores | Array of UserApplicationStore | Application repository list. |
UserApplicationStatus
Application status information.
Used by actions: DescribeApplicationStatus.
| Name | Type | Description |
|---|---|---|
| ApplicationId | String | Application ID. |
| ApplicationRunStatus | String | Application running status (ApplicationDeleting: application deletion in progress; ApplicationCreateFail: application creation failed; ApplicationCreating: application creation in progress; ApplicationRunning: normal running; ApplicationNoConfigured: main execution program path not configured; ApplicationNoPackage: no available package). |
| ApplicationUpdateStatus | String | Application update status (ApplicationUpdateCreating: version creation in progress; ApplicationUpdateCreateFail: version creation failed; ApplicationUpdateNoReleased: version to be released; ApplicationUpdateReleased: version release completed; ApplicationUpdateNormal: none). |
| ApplicationUpdateProgress | Integer | Application update progress. |
UserApplicationStore
Application repository information.
Used by actions: DescribeApplicationList, ModifyApplicationBaseInfo.
| Name | Type | Required | Description |
|---|---|---|---|
| CosBucket | String | Yes | COS bucket name. Note: This field may return null, indicating that no valid values can be obtained. |
| CosRegion | String | Yes | COS bucket region. Note: This field may return null, indicating that no valid values can be obtained. |
| StoreType | String | Yes | Repository type. LOG: application logs; ARCHIVE: application archive. Note: This field may return null, indicating that no valid values can be obtained. |
| StoreState | String | Yes | Repository status. ON: enabled; OFF: disabled. Note: This field may return null, indicating that no valid values can be obtained. |
| StorePath | String | Yes | Repository path. Note: This field may return null, indicating that no valid values can be obtained. |
UserApplicationVersion
Application version information.
Used by actions: CreateApplicationVersion, DescribeApplicationList, DescribeApplicationVersion, SetApplicationVersionOnline.
| Name | Type | Description |
|---|---|---|
| ApplicationVersionId | String | Application version ID. |
| ApplicationVersionSize | Integer | Application version size. |
| ApplicationVersionStatus | String | Application version status (Uploading: uploading; Creating: in creation; CreateFailed: creation failed; Deleting: deleting; Inuse: current version; Normal: to be released; Usable: available). |
| ApplicationVersionName | String | Application version name. |
| CreateTime | Timestamp ISO8601 | Application version creation time. |
| ApplicationVersionRegions | Array of String | Region for application version distribution ( Standard zone: ap-chinese-mainland: Chinese mainland na-north-america: North America eu-frankfurt: Frankfurt ap-mumbai: Mumbai ap-tokyo: Tokyo ap-seoul: Seoul ap-singapore: Singapore ap-bangkok: Bangkok ap-hongkong: Hong Kong (China) Integration zone: me-middle-east-fusion: Middle East na-north-america-fusion: North America sa-south-america-fusion: South America ap-tokyo-fusion: Tokyo ap-seoul-fusion: Seoul eu-frankfurt-fusion: Frankfurt ap-singapore-fusion: Singapore ap-hongkong-fusion: Hong Kong (China) ). Note: This field may return null, indicating that no valid values can be obtained. |
| ApplicationVersionUpdateMode | String | Application version update method. FULL: full update. INCREMENT: incremental update. Note: This field may return null, indicating that no valid values can be obtained. |
UserMobileApplicationInfo
Mobile application data information.
Used by actions: DescribeApplicationList.
| Name | Type | Description |
|---|---|---|
| ApplicationId | String | Application ID. |
| ApplicationName | String | Application name. |
| ApplicationType | String | Application type (cloud APK: application APK). |
| ApplicationRunStatus | String | Application running status (ApplicationRunning: normal running; ApplicationNoPackage: no available package). |
| ApplicationUpdateStatus | String | Application update status (ApplicationUpdateCreating: version creation in progress; ApplicationUpdateCreateFail: version creation failed; ApplicationUpdateNoReleased: version to be released; ApplicationUpdateReleased: version release completed; ApplicationUpdateNormal: none). |
| ApplicationCreateTime | Timestamp ISO8601 | Application creation time. |
| ApplicationVersions | Array of UserApplicationVersion | List of application versions. |
| ApplicationNature | String | Application nature (PUBLIC: public application; PRIVATE: user application). |
VideoEncodeConfig
Video encoding configuration.
Used by actions: CreateApplicationProject, DescribeApplicationProjectAdvancedConfig, ModifyApplicationProject.
| Name | Type | Required | Description |
|---|---|---|---|
| StreamPushGOPSeconds | Integer | No | Streaming GOP length, in seconds.Note: This field may return null, indicating that no valid values can be obtained. |
はい
いいえ
この記事はお役に立ちましたか？