{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-cgcs/batch-check-session":{"post":{"operationId":"cloud_aliyun_cgcs_batch_check_session","summary":"This API is used to check suspected abnormal sessions.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Records"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"Records":{"type":"string","description":"Records of suspected abnormal sessions. A maximum of 50 records are allowed. (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/cancel-reserve-task":{"post":{"operationId":"cloud_aliyun_cgcs_cancel_reserve_task","summary":"Cancel the specified container reservation job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"TaskId":{"type":"string","description":"The ID of the container reservation job"},"ClientToken":{"type":"string","description":"A custom token used to ensure request idempotence. It must consist of ASCII characters and cannot exceed 64 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/create-adaptation":{"post":{"operationId":"cloud_aliyun_cgcs_create_adaptation","summary":"Create an adaptation request for an application version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppVersionId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppVersionId":{"type":"string","description":"Application Version ID"},"AdaptTarget":{"type":"string","description":"Adaptation target information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/create-app":{"post":{"operationId":"cloud_aliyun_cgcs_create_app","summary":"Create a new application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppName","AppType"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppName":{"type":"string","description":"Application name. Unicode characters are supported, with a maximum of 64 characters"},"AppType":{"type":"string","description":"Application type. Valid values: end_game: PC game (client-side game). ai_app: Artificial intelligence application. render_app: Rendering…"},"StreamingAppId":{"type":"string","description":"Graphic Computing Service streaming service instance ID"},"StreamingSolution":{"type":"string","description":"Streaming solution. Valid values: video-cloud-streaming: Use the Graphic Computing Service streaming service. self-have-streaming: Use…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/create-app-session":{"post":{"operationId":"cloud_aliyun_cgcs_create_app_session","summary":"Create an application session and start an application process, then return the session information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","CustomSessionId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID"},"AppVersion":{"type":"string","description":"Application Version ID. If you do not specify an active version, the default application uses the latest version"},"CustomUserId":{"type":"string","description":"Custom User ID, with a maximum length of 64 characters. Used by your business to perform operations based on the user dimension. This…"},"CustomSessionId":{"type":"string","description":"Custom session ID used to ensure idempotence of requests. Generate a unique value from your client to guarantee uniqueness across…"},"ClientIp":{"type":"string","description":"Client IP address of the business, such as the player's IP address in a cloud gaming scenario"},"StartParameters":{"type":"string","description":"Start parameters (JSON-encoded)"},"SystemInfo":{"type":"string","description":"System information, such as client device model (JSON-encoded)"},"Timeout":{"type":"integer","description":"Timeout for on-demand resource provisioning in pay-as-you-go mode. Value range: [900, 43200] seconds. Default value: 1800"},"EnablePostpaid":{"type":"string","description":"Specifies whether to provision resources on demand when creating a session in pay-as-you-go mode. Valid values: true: Yes false: No…"},"ProjectId":{"type":"string","description":"项目ID。如果已将应用关联到项目，创建会话时需填写正确的项目ID"},"AdapterFileId":{"type":"string","description":"适配文件ID。此功能灰度开放，如未约定使用请勿传入"},"DistrictId":{"type":"string","description":"Area ID. Valid values: huadong xinan huanan huabei huazhong"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/create-app-session-batch-sync":{"post":{"operationId":"cloud_aliyun_cgcs_create_app_session_batch_sync","summary":"You can batch create application sessions. The platform allocates resources and starts multiple processes…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BatchId","AppInfos"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"BatchId":{"type":"string","description":"Custom batch operation ID. It must be unique. Supports ASCII characters and must not exceed 64 characters"},"AppInfos":{"type":"string","description":"Application start information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/create-app-session-sync":{"post":{"operationId":"cloud_aliyun_cgcs_create_app_session_sync","summary":"After you create an application session and start the application process, the session information is…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","CustomSessionId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID"},"AppVersion":{"type":"string","description":"Application Version ID."},"CustomUserId":{"type":"string","description":"Custom User ID. Used for reading from and saving to archives. The maximum length is 64 characters. This parameter is Required when the…"},"CustomSessionId":{"type":"string","description":"Custom session ID. Supports ASCII characters and must not exceed 64 characters"},"ClientIp":{"type":"string","description":"Client IP address of the business"},"StartParameters":{"type":"string","description":"Business customization parameters. (JSON-encoded)"},"SystemInfo":{"type":"string","description":"System information. (JSON-encoded)"},"Tags":{"type":"string","description":"Custom tags (JSON-encoded)"},"ProjectId":{"type":"string","description":"Project ID"},"DistrictId":{"type":"string","description":"Area ID. Valid values: huadong xinan huanan huabei huazhong"},"MatchRules":{"type":"string","description":"Rule information for resource matching. Multiple rules are supported. The more rules specified, the longer the Duration required to find a…"},"AdapterFileId":{"type":"string","description":"Adapter file ID. This feature is released in grayscale. Do not pass this parameter unless agreed upon"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/create-app-version":{"post":{"operationId":"cloud_aliyun_cgcs_create_app_version","summary":"Create a new version for an application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","AppVersionName"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the application to which the application version belongs"},"AppVersionName":{"type":"string","description":"Application Version Name. Supports Unicode characters, with a maximum of 32 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/create-capacity-reservation":{"post":{"operationId":"cloud_aliyun_cgcs_create_capacity_reservation","summary":"Create a container reservation job. The reservation can run containers that support a specified number of…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","AppId","DistrictId","ExpectSessionCapacity"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ProjectId":{"type":"string","description":"Project ID"},"AppId":{"type":"string","description":"The application ID"},"AppVersion":{"type":"string","description":"The Application Version ID"},"DistrictId":{"type":"string","description":"Area ID. Valid values: huadong xinan huanan huabei huazhong"},"ExpectResourceReadyTime":{"type":"string","description":"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":{"type":"integer","description":"Expected number of sessions to support"},"ClientToken":{"type":"string","description":"Custom token used to ensure Request idempotence. ASCII characters are supported, and the length must not exceed 64 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/delete-app":{"post":{"operationId":"cloud_aliyun_cgcs_delete_app","summary":"Delete an application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/delete-app-version":{"post":{"operationId":"cloud_aliyun_cgcs_delete_app_version","summary":"Delete a version of an application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppVersionId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppVersionId":{"type":"string","description":"Application Version ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/describe-instance-stats-info":{"post":{"operationId":"cloud_aliyun_cgcs_describe_instance_stats_info","summary":"This API queries statistics information about Graphic Computing Service instances purchased by users, across…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ProjectIds":{"type":"string","description":"List of project IDs. If left blank, all project IDs are included by default (JSON-encoded)"},"InstanceTypes":{"type":"string","description":"List of instance types. If left blank, all instance types are included by default (JSON-encoded)"},"DistrictIds":{"type":"string","description":"List of District IDs. If left blank, all District IDs are included by default (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/get-adaptation":{"post":{"operationId":"cloud_aliyun_cgcs_get_adaptation","summary":"Query the details of an adaptation request","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppVersionId":{"type":"string","description":"Application Version ID. Specify either `AppVersionId` or `AdaptApplyId`. If both are provided, this parameter takes precedence."},"AdaptApplyId":{"type":"integer","description":"Adaptation Request ID. Either `AppVersionId` or `AdaptApplyId` must be specified"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/get-app":{"post":{"operationId":"cloud_aliyun_cgcs_get_app","summary":"Query the details of a single application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/get-app-ccu":{"post":{"operationId":"cloud_aliyun_cgcs_get_app_ccu","summary":"Query the details of running sessions.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ProjectId":{"type":"string","description":"Project ID"},"AppId":{"type":"string","description":"Application ID."},"AppVersion":{"type":"string","description":"Application Version ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/get-app-session":{"post":{"operationId":"cloud_aliyun_cgcs_get_app_session","summary":"Obtain application session details","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"PlatformSessionId":{"type":"string","description":"Platform session ID, which uniquely identifies a session in the platform. Note: Either PlatformSessionId or CustomSessionId must be…"},"CustomSessionId":{"type":"string","description":"Custom session ID, used to query the most recent application session record that has not ended. Note: You must specify either…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/get-app-version":{"post":{"operationId":"cloud_aliyun_cgcs_get_app_version","summary":"Query the details of a specific application version.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppVersionId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppVersionId":{"type":"string","description":"Application Version ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/get-capacity":{"post":{"operationId":"cloud_aliyun_cgcs_get_capacity","summary":"Query container information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ProjectId":{"type":"string","description":"Project ID"},"AppId":{"type":"string","description":"Application ID"},"AppVersion":{"type":"string","description":"Application Version ID"},"DistrictId":{"type":"string","description":"Area ID. Valid values: huadong xinan huanan huabei huazhong"},"PageSize":{"type":"integer","description":"Number of data rows displayed per page during paging. Maximum value: 100. Default value: 20"},"PageNum":{"type":"integer","description":"Page number. Starting value: 1. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/get-reserve-task-detail":{"post":{"operationId":"cloud_aliyun_cgcs_get_reserve_task_detail","summary":"Query the details of a container reservation job.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"TaskId":{"type":"string","description":"Capacity reservation job ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/list-app":{"post":{"operationId":"cloud_aliyun_cgcs_list_app","summary":"Query the application list","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"KeySearch":{"type":"string","description":"Search keyword. You can perform a fuzzy query by entering an application ID or application name"},"PageNumber":{"type":"integer","description":"The page number. Starting value: 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of data rows displayed per page during paging. Valid values: 1 to 9999. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/list-app-sessions":{"post":{"operationId":"cloud_aliyun_cgcs_list_app_sessions","summary":"Query the application session list. Batch queries are supported. Only information about sessions that have…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"PlatformSessionIds":{"type":"string","description":"List of platform session IDs (JSON-encoded)"},"CustomSessionIds":{"type":"string","description":"List of custom session IDs (JSON-encoded)"},"PageSize":{"type":"integer","description":"Number of entries per page for paged query. Maximum value is 100. Default value is 20."},"PageNumber":{"type":"integer","description":"Page number of the instance list. Starting value is 1. Default value is 1."},"AppId":{"type":"string","description":"Application ID"},"ProjectId":{"type":"string","description":"Project ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/list-app-version":{"post":{"operationId":"cloud_aliyun_cgcs_list_app_version","summary":"Query the version list of an application.","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppId":{"type":"string","description":"Application ID."},"PageNumber":{"type":"integer","description":"Page number. Starting value: 1. Default Value: 1."},"PageSize":{"type":"integer","description":"Number of data entries per page for paging. Valid values: 1 to 9999. Default Value: 10."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/list-instances":{"post":{"operationId":"cloud_aliyun_cgcs_list_instances","summary":"Lists Graphic Computing Service (GCS) instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ProjectId":{"type":"string","description":"The project ID. If not specified, instances from all projects are queried"},"InstanceType":{"type":"string","description":"The instance type of GCS. If not specified, all instance types are included"},"DistrictId":{"type":"string","description":"The district ID. If not specified, all districts are included. Valid values: huadong xinan huanan huabei huazhong"},"InstanceId":{"type":"string","description":"The list of GCS instance IDs to query. If not specified, all instance IDs are included (JSON-encoded)"},"NextToken":{"type":"string","description":"The token returned from the previous query. Leave empty for the first query"},"MaxResults":{"type":"integer","description":"The maximum number of results. Valid values: 1 to 200. Default: 200"},"Status":{"type":"string","enum":["CREATING","RUNNING","OPERATING","DELETING","MIGRATING"],"description":"The status of GCS instances. Valid values: CREATING: Creating RUNNING: during instance runtime OPERATING: O\\&M DELETING: Deleting…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/modify-app":{"post":{"operationId":"cloud_aliyun_cgcs_modify_app","summary":"Modify the name of an application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","AppName"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppId":{"type":"string","description":"The application ID"},"AppName":{"type":"string","description":"The application Name. Supports Unicode characters, with a maximum of 64 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/modify-app-version":{"post":{"operationId":"cloud_aliyun_cgcs_modify_app_version","summary":"Modify the version information of an application","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppVersionId","AppVersionName"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"AppVersionId":{"type":"string","description":"Application Version ID"},"AppVersionName":{"type":"string","description":"Application Version Name. Supports Unicode characters, with a maximum of 32 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/release-capacity":{"post":{"operationId":"cloud_aliyun_cgcs_release_capacity","summary":"Release the reserved container. The container is released only when all specified conditions are met…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","AppId","DistrictId","ExpectReleaseSessionCapacity"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ProjectId":{"type":"string","description":"The project ID."},"AppId":{"type":"string","description":"The application ID."},"DistrictId":{"type":"string","description":"The area ID. Valid values: huadong xinan huanan huabei huazhong"},"ExpectReleaseSessionCapacity":{"type":"integer","description":"The expected number of ingest endpoints of sessions to release."},"AppVersion":{"type":"string","description":"The version ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/release-capacity-by-batch":{"post":{"operationId":"cloud_aliyun_cgcs_release_capacity_by_batch","summary":"Release the machines in the specified batch. This is typically performed when the dry run fails, to release…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResBatchId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ResBatchId":{"type":"string","description":"The resource batch ID returned during reservation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/release-instances":{"post":{"operationId":"cloud_aliyun_cgcs_release_instances","summary":"Release Graphic Computing Service (GCS) instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","InstanceType","DistrictId","Amount"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ProjectId":{"type":"string","description":"Project ID"},"InstanceType":{"type":"string","description":"The GCS instance type"},"DistrictId":{"type":"string","description":"Region ID. Valid values: East China Southwest China South China North China Central China"},"Amount":{"type":"integer","description":"The number of Graphic Computing Service instances to release. Value range: 1 to 500"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/reserve-instances":{"post":{"operationId":"cloud_aliyun_cgcs_reserve_instances","summary":"Reserves Graphic Computing Service (GCS) instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","InstanceType","DistrictId","Amount"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"ProjectId":{"type":"string","description":"The project ID"},"InstanceType":{"type":"string","description":"The instance type of the GCS instance"},"DistrictId":{"type":"string","description":"The district ID. Valid values: huadong xinan huanan huabei huazhong"},"Amount":{"type":"integer","description":"The number of GCS instances to reserve. The value must be between 1 and 500"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/stop-app-session":{"post":{"operationId":"cloud_aliyun_cgcs_stop_app_session","summary":"Stop an application session. The result of the stop operation will be returned through a message","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"PlatformSessionId":{"type":"string","description":"Platform session ID, which uniquely identifies a session on the platform. Note: PlatformSessionId and CustomSessionId are mutually…"},"CustomSessionId":{"type":"string","description":"Custom session ID. Note: PlatformSessionId and CustomSessionId are mutually exclusive. If both parameters are set, PlatformSessionId takes…"},"StopParam":{"type":"string","description":"停止容器参数。此参数将透传到Agent (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/stop-app-session-batch":{"post":{"operationId":"cloud_aliyun_cgcs_stop_app_session_batch","summary":"Batch stop application sessions. The subsequent stop results are returned through an HTTP API","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BatchId"],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"},"BatchId":{"type":"string","description":"Batch operation ID. Supports ASCII characters and cannot exceed 64 characters"},"ProjectId":{"type":"string","description":"Project ID"},"AppId":{"type":"string","description":"Application ID"},"AppVersion":{"type":"string","description":"Application Version ID"},"Tags":{"type":"string","description":"Custom tags (JSON-encoded)"},"StopParam":{"type":"string","description":"Stop container parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-cgcs/version":{"post":{"operationId":"cloud_aliyun_cgcs_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://cgcs.cn-hangzhou.aliyuncs.com"],"default":"https://cgcs.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://cgcs.cn-hangzhou.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}