# Alibaba Cloud Graphic Computing Service API

> Alibaba Cloud Graphic Computing Service API on Apizie: 32 endpoints (This API is used to check suspected abnormal sessions., Cancel the specified container reservation job, Create an adaptation request for an application version, Create a new application, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-cgcs/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-cgcs`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/cgcs
- Page: https://www.apizie.tech/api/cloud/aliyun-cgcs
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-cgcs/openapi.json

Alibaba Cloud OpenAPI for Graphic Computing Service (cgcs, version 2021-11-11). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### This API is used to check suspected abnormal sessions.
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/batch-check-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| Records | string | yes | Records of suspected abnormal sessions. A maximum of 50 records are allowed. (JSON-encoded) |

### Cancel the specified container reservation job
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/cancel-reserve-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| TaskId | string | yes | The ID of the container reservation job |
| ClientToken | string | no | A custom token used to ensure request idempotence. It must consist of ASCII characters and cannot exceed 64 characters in length |

### Create an adaptation request for an application version
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/create-adaptation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppVersionId | string | yes | Application Version ID |
| AdaptTarget | string | no | Adaptation target information (JSON-encoded) |

### Create a new application
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/create-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppName | string | yes | Application name. Unicode characters are supported, with a maximum of 64 characters |
| AppType | string | yes | Application type. Valid values: end_game: PC game (client-side game). ai_app: Artificial intelligence application. render_app: Rendering… |
| StreamingAppId | string | no | Graphic Computing Service streaming service instance ID |
| StreamingSolution | string | no | Streaming solution. Valid values: video-cloud-streaming: Use the Graphic Computing Service streaming service. self-have-streaming: Use… |

### Create an application session and start an application process, then return the session information
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/create-app-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppId | string | yes | Application ID |
| AppVersion | string | no | Application Version ID. If you do not specify an active version, the default application uses the latest version |
| CustomUserId | string | no | Custom User ID, with a maximum length of 64 characters. Used by your business to perform operations based on the user dimension. This… |
| CustomSessionId | string | yes | Custom session ID used to ensure idempotence of requests. Generate a unique value from your client to guarantee uniqueness across… |
| ClientIp | string | no | Client IP address of the business, such as the player's IP address in a cloud gaming scenario |
| StartParameters | string | no | Start parameters (JSON-encoded) |
| SystemInfo | string | no | System information, such as client device model (JSON-encoded) |
| Timeout | integer | no | Timeout for on-demand resource provisioning in pay-as-you-go mode. Value range: [900, 43200] seconds. Default value: 1800 |
| EnablePostpaid | string | no | Specifies whether to provision resources on demand when creating a session in pay-as-you-go mode. Valid values: true: Yes false: No… |
| ProjectId | string | no | 项目ID。如果已将应用关联到项目，创建会话时需填写正确的项目ID |
| AdapterFileId | string | no | 适配文件ID。此功能灰度开放，如未约定使用请勿传入 |
| DistrictId | string | no | Area ID. Valid values: huadong xinan huanan huabei huazhong |

### You can batch create application sessions. The platform allocates resources and starts multiple processes…
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/create-app-session-batch-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| BatchId | string | yes | Custom batch operation ID. It must be unique. Supports ASCII characters and must not exceed 64 characters |
| AppInfos | string | yes | Application start information (JSON-encoded) |

### After you create an application session and start the application process, the session information is…
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/create-app-session-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppId | string | yes | Application ID |
| AppVersion | string | no | Application Version ID. |
| CustomUserId | string | no | Custom User ID. Used for reading from and saving to archives. The maximum length is 64 characters. This parameter is Required when the… |
| CustomSessionId | string | yes | Custom session ID. Supports ASCII characters and must not exceed 64 characters |
| ClientIp | string | no | Client IP address of the business |
| StartParameters | string | no | Business customization parameters. (JSON-encoded) |
| SystemInfo | string | no | System information. (JSON-encoded) |
| Tags | string | no | Custom tags (JSON-encoded) |
| ProjectId | string | no | Project ID |
| DistrictId | string | no | Area ID. Valid values: huadong xinan huanan huabei huazhong |
| MatchRules | string | no | Rule information for resource matching. Multiple rules are supported. The more rules specified, the longer the Duration required to find a… |
| AdapterFileId | string | no | Adapter file ID. This feature is released in grayscale. Do not pass this parameter unless agreed upon |

### Create a new version for an application
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/create-app-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppId | string | yes | The ID of the application to which the application version belongs |
| AppVersionName | string | yes | Application Version Name. Supports Unicode characters, with a maximum of 32 characters |

### Create a container reservation job. The reservation can run containers that support a specified number of…
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/create-capacity-reservation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ProjectId | string | yes | Project ID |
| AppId | string | yes | The application ID |
| AppVersion | string | no | The Application Version ID |
| DistrictId | string | yes | Area ID. Valid values: huadong xinan huanan huabei huazhong |
| ExpectResourceReadyTime | string | no | Expected time when resources become ready to serve. Time format: `yyyy-mm-dd HH:MM:SS`. Time Zone is UTC+8. This parameter applies only to… |
| ExpectSessionCapacity | integer | yes | Expected number of sessions to support |
| ClientToken | string | no | Custom token used to ensure Request idempotence. ASCII characters are supported, and the length must not exceed 64 characters |

### Delete an application
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/delete-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppId | string | yes | The application ID |

### Delete a version of an application
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/delete-app-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppVersionId | string | yes | Application Version ID |

### This API queries statistics information about Graphic Computing Service instances purchased by users, across…
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/describe-instance-stats-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ProjectIds | string | no | List of project IDs. If left blank, all project IDs are included by default (JSON-encoded) |
| InstanceTypes | string | no | List of instance types. If left blank, all instance types are included by default (JSON-encoded) |
| DistrictIds | string | no | List of District IDs. If left blank, all District IDs are included by default (JSON-encoded) |

### Query the details of an adaptation request
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/get-adaptation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppVersionId | string | no | Application Version ID. Specify either `AppVersionId` or `AdaptApplyId`. If both are provided, this parameter takes precedence. |
| AdaptApplyId | integer | no | Adaptation Request ID. Either `AppVersionId` or `AdaptApplyId` must be specified |

### Query the details of a single application
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/get-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppId | string | yes | Application ID |

### Query the details of running sessions.
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/get-app-ccu` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ProjectId | string | no | Project ID |
| AppId | string | no | Application ID. |
| AppVersion | string | no | Application Version ID. |

### Obtain application session details
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/get-app-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| PlatformSessionId | string | no | Platform session ID, which uniquely identifies a session in the platform. Note: Either PlatformSessionId or CustomSessionId must be… |
| CustomSessionId | string | no | Custom session ID, used to query the most recent application session record that has not ended. Note: You must specify either… |

### Query the details of a specific application version.
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/get-app-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppVersionId | string | yes | Application Version ID. |

### Query container information
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/get-capacity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ProjectId | string | no | Project ID |
| AppId | string | no | Application ID |
| AppVersion | string | no | Application Version ID |
| DistrictId | string | no | Area ID. Valid values: huadong xinan huanan huabei huazhong |
| PageSize | integer | no | Number of data rows displayed per page during paging. Maximum value: 100. Default value: 20 |
| PageNum | integer | no | Page number. Starting value: 1. Default value: 1 |

### Query the details of a container reservation job.
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/get-reserve-task-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| TaskId | string | yes | Capacity reservation job ID |

### Query the application list
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/list-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| KeySearch | string | no | Search keyword. You can perform a fuzzy query by entering an application ID or application name |
| PageNumber | integer | no | The page number. Starting value: 1. Default value: 1 |
| PageSize | integer | no | The number of data rows displayed per page during paging. Valid values: 1 to 9999. Default value: 10 |

### Query the application session list. Batch queries are supported. Only information about sessions that have…
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/list-app-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| PlatformSessionIds | string | no | List of platform session IDs (JSON-encoded) |
| CustomSessionIds | string | no | List of custom session IDs (JSON-encoded) |
| PageSize | integer | no | Number of entries per page for paged query. Maximum value is 100. Default value is 20. |
| PageNumber | integer | no | Page number of the instance list. Starting value is 1. Default value is 1. |
| AppId | string | no | Application ID |
| ProjectId | string | no | Project ID. |

### Query the version list of an application.
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/list-app-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppId | string | yes | Application ID. |
| PageNumber | integer | no | Page number. Starting value: 1. Default Value: 1. |
| PageSize | integer | no | Number of data entries per page for paging. Valid values: 1 to 9999. Default Value: 10. |

### Lists Graphic Computing Service (GCS) instances
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ProjectId | string | no | The project ID. If not specified, instances from all projects are queried |
| InstanceType | string | no | The instance type of GCS. If not specified, all instance types are included |
| DistrictId | string | no | The district ID. If not specified, all districts are included. Valid values: huadong xinan huanan huabei huazhong |
| InstanceId | string | no | The list of GCS instance IDs to query. If not specified, all instance IDs are included (JSON-encoded) |
| NextToken | string | no | The token returned from the previous query. Leave empty for the first query |
| MaxResults | integer | no | The maximum number of results. Valid values: 1 to 200. Default: 200 |
| Status | string | no | The status of GCS instances. Valid values: CREATING: Creating RUNNING: during instance runtime OPERATING: O\&M DELETING: Deleting… |

### Modify the name of an application
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/modify-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppId | string | yes | The application ID |
| AppName | string | yes | The application Name. Supports Unicode characters, with a maximum of 64 characters |

### Modify the version information of an application
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/modify-app-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| AppVersionId | string | yes | Application Version ID |
| AppVersionName | string | yes | Application Version Name. Supports Unicode characters, with a maximum of 32 characters |

### Release the reserved container. The container is released only when all specified conditions are met…
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/release-capacity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ProjectId | string | yes | The project ID. |
| AppId | string | yes | The application ID. |
| DistrictId | string | yes | The area ID. Valid values: huadong xinan huanan huabei huazhong |
| ExpectReleaseSessionCapacity | integer | yes | The expected number of ingest endpoints of sessions to release. |
| AppVersion | string | no | The version ID. |

### Release the machines in the specified batch. This is typically performed when the dry run fails, to release…
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/release-capacity-by-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ResBatchId | string | yes | The resource batch ID returned during reservation |

### Release Graphic Computing Service (GCS) instances
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/release-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ProjectId | string | yes | Project ID |
| InstanceType | string | yes | The GCS instance type |
| DistrictId | string | yes | Region ID. Valid values: East China Southwest China South China North China Central China |
| Amount | integer | yes | The number of Graphic Computing Service instances to release. Value range: 1 to 500 |

### Reserves Graphic Computing Service (GCS) instances
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/reserve-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| ProjectId | string | yes | The project ID |
| InstanceType | string | yes | The instance type of the GCS instance |
| DistrictId | string | yes | The district ID. Valid values: huadong xinan huanan huabei huazhong |
| Amount | integer | yes | The number of GCS instances to reserve. The value must be between 1 and 500 |

### Stop an application session. The result of the stop operation will be returned through a message
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/stop-app-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| PlatformSessionId | string | no | Platform session ID, which uniquely identifies a session on the platform. Note: PlatformSessionId and CustomSessionId are mutually… |
| CustomSessionId | string | no | Custom session ID. Note: PlatformSessionId and CustomSessionId are mutually exclusive. If both parameters are set, PlatformSessionId takes… |
| StopParam | string | no | 停止容器参数。此参数将透传到Agent (JSON-encoded) |

### Batch stop application sessions. The subsequent stop results are returned through an HTTP API
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/stop-app-session-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |
| BatchId | string | yes | Batch operation ID. Supports ASCII characters and cannot exceed 64 characters |
| ProjectId | string | no | Project ID |
| AppId | string | no | Application ID |
| AppVersion | string | no | Application Version ID |
| Tags | string | no | Custom tags (JSON-encoded) |
| StopParam | string | no | Stop container parameters (JSON-encoded) |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com |

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-cgcs/batch-check-session" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Graphic Computing Service API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-cgcs/batch-check-session with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Graphic Computing Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Graphic Computing Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Graphic Computing Service API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-cgcs.

### What is the status of the Alibaba Cloud Graphic Computing Service API?
Needs your own provider key (bring your own key)