查询实例列表
更新时间 2026-05-28 11:32:24
最近更新时间: 2026-05-28 11:32:24
接口功能介绍
查询实例列表
接口约束
无
URI
GET /crs/openapi/instance/listInstance
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNum | 否 | Integer | 当前页码 | 1 | |
| pageSize | 否 | Integer | 每页大小 | 10 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | 类型 | application/json | |
| regionId | 是 | String | 资源池编码（资源池ID，您可以查看容器镜像服务资源池获取） | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| code | Integer | 响应码 | 0 | |
| message | String | 返回信息 | ||
| data | Object | 返回结果 | data | |
| error | String | 错误信息 |
表 data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总条数 | 5 | |
| size | Integer | 每页条数 | 10 | |
| current | Integer | 当前页码 | 1 | |
| pages | Integer | 总页数 | 1 | |
| records | Object | 实例列表 | records |
表 records
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceId | Long | 实例ID | 1638470585571688449 | |
| instanceName | String | 实例名称 | personal | |
| instanceType | String | 实例类型（personal：个人版） | personal | |
| userName | String | 用户名（用以推送、拉取镜像） | crs-user | |
| state | String | 实例状态 | RUNNING | |
| createdTime | String | 实例开通时间 | 2023-03-22 17:20:04 |
枚举参数
无
请求示例
请求url
GET https://[endpoint].ctapi.ctyun.cn/crs/openapi/instance/listInstance?pageNow=1&pageSize=10
请求头header
{
"Content-Type":"application/json"
}
请求体body
无
响应示例
{
"code":0,
"message":"",
"data":{
"records":[
{
"instanceId":"1638470585571688449",
"instanceName":"personal",
"instanceType":"personal",
"userName":"crs-user0322-1707",
"state":"RUNNING",
"createdTime":"2023-03-22 17: 20: 04"
}
],
"total":"1",
"size":"10",
"current":"1",
"orders":[
],
"optimizeCountSql":true,
"hitCount":false,
"countId":null,
"maxLimit":null,
"searchCount":true,
"pages":"1"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
