Invoke CloudBase Run service

POST 
/v1/cloudrun/:name/:anyPath

Invoke the specified CloudBase Run service.

When calling CloudBase Run through the open APIs, the response headers are adjusted to mitigate potential compliance-related blocking risks:

1. For all responses to GET requests, the header Content-Disposition: attachment is added.
2. For non-text responses (text types include application/json, application/x-www-form-urlencoded, and text/plain in the response Content-Type header), the header Content-Disposition: attachment is added.

Note: SSE (Server-Sent Event) and WebSocket requests are exempt from these adjustments.

Request

Path Parameters

name stringrequired

Possible values: Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]{0,58}[a-zA-Z0-9]$

Name of the service to invoke

anyPath string

Append any additional path segments

application/json

Body

Request payload for invoking the CloudBase Run service

property name* any

Responses

200

Returned when the call succeeds

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

property name* any

Example (from schema)

{}

Echo

echo

{
  "a": 1,
  "b": 2
}

text/plain

Schema

Schema

string

Text

text

Hello world

403

Returned when the CloudBase Run call fails

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

code Error code (string)
message Error message (string)
requestId Request ID (string)

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

ServiceForbidden

Access to the CloudBase Run service was denied

{
  "code": "SERVICE_FORBIDDEN",
  "message": "Service forbidden. For more information, please refer to https://docs.cloudbase.net/error-code/service",
  "requestId": "yyxxxxxx-yyyy-yyyy-zzzz-xxxxxxzzyyyy"
}

404

Returned when the CloudBase Run call fails

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

code Error code (string)
message Error message (string)
requestId Request ID (string)

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

ServiceNotFound

CloudBase Run service not found

{
  "code": "SERVICE_NOT_FOUND",
  "message": "Service not found. For more information, please refer to https://docs.cloudbase.net/error-code/service",
  "requestId": "yyxxxxxx-yyyy-yyyy-zzzz-xxxxxxzzyyyy"
}

default

Common error information, see https://docs.cloudbase.net/error-code/service for details

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

code Error code (string)
message Error message (string)
requestId Request ID (string)

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

InvalidHost

Invalid request address

{
  "code": "INVALID_HOST",
  "message": "xxx",
  "requestId": "xxx"
}

Loading...