Instance Management

Connect to Instance

Connect to an existing instance and get data-plane access info

POST

/api/v1/agentstudio/sandbox/sandboxes/{sandboxID}/connect

cURL

curl --request POST \
  --url 'https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/sandbox/sandboxes/{sandboxID}/connect' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timeout": 0
}
'

{
  "sandboxID": "<string>",
  "templateID": "<string>",
  "envdVersion": "<string>",
  "domain": "<string>",
  "envdAccessToken": "<string>",
  "trafficAccessToken": "<string>",
  "envdUrl": "<string>",
  "state": "<string>"
}

Authorizations

string

header

required

Path Parameters

string

required

实例唯一 ID

Body

application/json

integer

连接后实例的超时时间，单位秒，取值范围 [300,604800]

Required range:300 <= x <= 604800

Response

200-application/json

string

实例唯一 ID

string

模版 ID

string

envd 版本

string

数据面访问域名

string

envd 访问 token

string | null

流量访问 token

string

envd 访问地址

string

实例状态，例如 running

cURL

curl --request POST \
  --url 'https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/sandbox/sandboxes/{sandboxID}/connect' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timeout": 0
}
'

{
  "sandboxID": "<string>",
  "templateID": "<string>",
  "envdVersion": "<string>",
  "domain": "<string>",
  "envdAccessToken": "<string>",
  "trafficAccessToken": "<string>",
  "envdUrl": "<string>",
  "state": "<string>"
}