调用云托管服务

GET 
https://your-envId.api.tcloudbasegateway.com/v1/cloudrun/:name/:anyPath

调用指定云托管服务。

通过开放 API 访问云托管时，针对可能存在的合规封禁风险，开放 API 会对响应头进行如下更改：

1. 对于所有的 GET 请求返回的响应，响应头添加 Content-Disposition: attachment；
2. 对于非文本类型（文本类型包括响应头Content-Type中指示application/json、application/x-www-form-urlencoded、text/plain类型的返回内容）的响应，响应头添加 Content-Disposition: attachment；

注意：SSE(Server-Sent Event) 和 WebSocket 请求不受到上述限制。

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]$

需要调用的服务名称

anyPath string

追加任意路径

Responses

200

调用成功时返回

Response Headers

• X-Request-Id string

  请求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

云托管服务调用出错时返回

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

code 错误码 (string)
message 错误信息 (string)
requestId 请求 ID (string)

Example (from schema)

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

ServiceForbidden

云托管服务拒绝访问

{
  "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

云托管服务调用出错时返回

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

code 错误码 (string)
message 错误信息 (string)
requestId 请求 ID (string)

Example (from schema)

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

ServiceNotFound

未找到云托管服务

{
  "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

通用报错信息，详见 https://docs.cloudbase.net/error-code/service

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

code 错误码 (string)
message 错误信息 (string)
requestId 请求 ID (string)

Example (from schema)

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

InvalidHost

请求地址异常

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

Authorization: http

name: JWTAuthtype: httpscheme: bearerdescription: 环境 ID 所对应的 token，使用登录鉴权(v2)获取

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://your-envId.api.tcloudbasegateway.com/v1/cloudrun/:name/:anyPath' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://your-envId.api.tcloudbasegateway.com

Auth

Security Scheme

JWTAuthAPIKey

Bearer Token

Parameters

name — pathrequired

anyPath — path

ResponseClear

Click the Send API Request button above and see the response here!