Skip to main content
Version: 1.0.0

Cloud Run

Feature Introduction

This series of open APIs provides the ability to interface with CloudBase Run. Through these APIs you can invoke CloudBase Run services within an environment, with support for both SSE (Server-Sent Event) and WebSocket requests.

Access Guide

Calling the following APIs requires an AccessToken in the format Authorization: Bearer <token>. For details on how to obtain the token, refer to https://docs.cloudbase.net/http-api/basic/access-token.

HTTP Status Codes

Depending on the response result, status codes 2xx, 4xx, or 5xx may appear.

Error Codes

The following table lists the error codes specific to this series of APIs. For the complete list, refer to https://docs.cloudbase.net/error-code/service.

Error CodeDescription
SERVICE_NOT_FOUNDThe specified service was not found
SERVICE_TIMEOUTThe CloudBase Run service call timed out
SERVICE_FORBIDDENAccess to the CloudBase Run service was denied, possibly due to permission configuration or service status issues
SERVICE_NOT_READYThe CloudBase Run service is not ready
SERVICE_VERSION_NOT_FOUNDNo matching CloudBase Run service version was found
SERVICE_ENDPOINT_NOT_FOUNDNo available endpoint was found for the CloudBase Run service
SERVICE_LB_STATUS_ABNORMALThe load balancer status of the CloudBase Run service is abnormal; try creating a new version
SERVICE_RESOURCE_NOT_FOUNDNo resources associated with the service were found
SERVICE_CHARGE_OVERDUEService is suspended due to overdue payment. Please recharge in time.

Authentication

The token corresponding to the environment ID is obtained using login authentication (v2)

Security Scheme Type:http
HTTP Authorization Scheme:bearer

License

Apache 2.0