# 列出站点空间 - ListSandboxSites

## 简介

列出站点空间




## 使用方法

您可以选择以下方式中的任意一种，发起 API 请求：
- 多语言 OpenSDK /  /
- [CloudShell 云命令行](https://shell.ucloud.cn/)

## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `ListSandboxSites`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.ucloud.cn/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](https://docs.ucloud.cn/api/summary/signature)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](https://docs.ucloud.cn/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](https://docs.ucloud.cn/api/summary/get_project_list) |No|
| **Zone** | string | 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist) |**Yes**|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **Sites** | array[[*Site*](#site)] | 站点空间列表 |**Yes**|
| **CustomTargetDomain** | string | 目标域名地址 |No|

#### 数据模型

#### Site

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Name** | string | 名称 |**Yes**|
| **Ready** | boolean | 是否就绪 |**Yes**|
| **ID** | string | 站点ID |**Yes**|
| **SandboxID** | string | 沙箱ID |**Yes**|
| **Host** | string | 站点访问地址 |**Yes**|
| **KeyID** | string | 站点Key ID |**Yes**|
| **UpdateTime** | int | 更新时间 |**Yes**|
| **AccessCode** | string | 访问码 |**Yes**|
| **ConnectKey** | string | 连接密钥 |**Yes**|
| **Envs** | array[string] | 站点环境变量。格式：["key=value"] |No|
| **CustomDomain** | string | 自定义域名 |No|
| **CustomDomainStatus** | string | 自定义域名签发状态 |No|
| **CustomDomainError** | string | 自定义域名签发错误信息 |No|
| **IPAccess** | [*SiteIPAccess*](#siteipaccess) | IP限制 |No|

#### SiteIPAccess

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **IPList** | array[string] | IP 列表 |No|
| **Mode** | string | IP限制模式<br />"":不限制IP<br />“allow”:自定义白名单<br />“deny”:自定义黑名单 |No|

## 示例

### 请求示例
```
https://api.ucloud.cn/?Action=ListSandboxSites
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=xkKVrwzj
```

### 响应示例
```json
{
  "Action": "ListSandboxSitesResponse",
  "RetCode": 0,
  "Stations": [
    {
      "Envs": [
        "xEyFuHoK"
      ],
      "Host": "aAaRsGLP",
      "ID": "JZMcELbf",
      "KeyID": "ExnqYtsV",
      "Name": "dzWndXCO",
      "Ready": false,
      "SandboxID": "gfXPYnRG",
      "UpdateTime": 2
    }
  ]
}
```