Invoke Cloud Hosting Service
GET/v1/cloudrun/:name/:anyPath
Invoke the specified cloud hosting service.
When accessing cloud hosting via Open API, to address potential compliance blocking risks, Open API will make the following changes to the response headers:
- For all responses to
GET
requests, addContent-Disposition: attachment
to the response headers. - For non-text types (text types include responses with the
Content-Type
header indicatingapplication/json
,application/x-www-form-urlencoded
, ortext/plain
), addContent-Disposition: attachment
to the response headers;
Note:
SSE(Server-Sent Event)
andWebSocket
requests are not subject to the above restrictions.
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]$
Service name to invoke
anyPath string
Append arbitrary path
Responses
- 200
- 403
- 404
- default
Returned on success
Response Headers
X-Request-Id string
Request ID
- application/json
- text/plain
- Schema
- Example (from schema)
- Echo
Schema
property name* any
{}
echo
{
"a": 1,
"b": 2
}
- Schema
- Text
Schema
string
text
Hello world
Returned when an error occurs in cloud hosting service invocation.
Response Headers
X-Request-Id string
Request ID
- application/json
- Schema
- Example (from schema)
- ServiceForbidden
Schema
code Error code (string)
message Error message (string)
requestId Request ID (string)
{
"code": "string",
"message": "string",
"requestId": "string"
}
Cloud hosting service access 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"
}
Returned when an error occurs in cloud hosting service invocation.
Response Headers
X-Request-Id string
Request ID
- application/json
- Schema
- Example (from schema)
- ServiceNotFound
Schema
code Error code (string)
message Error message (string)
requestId Request ID (string)
{
"code": "string",
"message": "string",
"requestId": "string"
}
Cloud hosting 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"
}
General error message. See https://docs.cloudbase.net/error-code/service
Response Headers
X-Request-Id string
Request ID
- application/json
- Schema
- Example (from schema)
- InvalidHost
Schema
code Error code (string)
message Error message (string)
requestId Request ID (string)
{
"code": "string",
"message": "string",
"requestId": "string"
}
Invalid request address
{
"code": "INVALID_HOST",
"message": "xxx",
"requestId": "xxx"
}
Loading...