接口请求域名： smh.intl.tencentcloudapi.com 。
查询官方云盘实例
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOfficialInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-12。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| SuperAdminAccount | 否 | Boolean | 是否查询实例绑定的超级管理员账号，默认值为 false。 |
| InstanceIds.N | 否 | Array of String | 按照一个或者多个实例 ID 查询，每次请求的上限为 100 个。 |
| PageNumber | 否 | Integer | 页码，整型，配合 PageSize 使用，默认值为 1。 |
| PageSize | 否 | Integer | 每页数目，整型，配合 PageNumber 使用，默认值为 20，最大值为 100。 |
| OrderBy | 否 | String | 对指定列进行排序 |
| OrderByType | 否 | String | 排序方式 |
| AutoRenew | 否 | Integer | 续费管理筛选类型 |
| BindPhone | 否 | Boolean | 超级管理管理员账号是否绑定了手机号 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| List | Array of Instance | 实例列表 |
| TotalCount | Integer | 总数 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: smh.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOfficialInstances
<公共请求参数>
{}
{
"Response": {
"List": [
{
"InstanceId": "jexrwwoa",
"Domain": "jexrwwoa.cofile.net",
"EffectiveTime": "2021-11-17T03:03:45Z",
"ExpireTime": "2021-12-17T23:59:59Z",
"UserLimit": 5,
"StorageLimit": "53687091200",
"StorageLimitGB": 50,
"Isolated": false,
"AutoRenew": 1,
"SuperAdminAccount": null
}
],
"TotalCount": 1,
"RequestId": "27ec9933-ad39-46b0-9ea1-f863a89dd00c"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameterValue.LimitExceeded | 参数值数量或字符数超过限制。 |
文档反馈