分页查询实例列表

请求参数

Authorization

Query 参数

bizState

integer <int32>

实例状态

可选

>= 1<= 19

示例值:

consumerCode

string

可选

消费者编码，查询该消费者可绑的实例列表时需传

示例值:

123abc

desc

enum<boolean>

排序方式，默认降序

可选

枚举值:

falsetrue

默认值:

true

示例值:

true

instanceCode

string

实例ID

可选

示例值:

7a2828074ef6e32e041a2ef124b19e63

instanceName

string

实例名称

可选

示例值:

agw-test

labelIds

string

可选

标签的Id串，多个标签以,连接

示例值:

id_1%2Cid_2

orderBy

enum<string>

可选

排序对象，从页面可见列中选择，默认用开通时间

枚举值:

billModebizStateexpireTimegmCreateinstanceCodeinstanceNameprojectNameskuCode

默认值:

gmUpdate

示例值:

gmCreate

pageNum

integer <int32>

页码

可选

默认值:

示例值:

pageSize

integer <int32>

每页记录数

可选

默认值:

示例值:

pluginCode

string

可选

插件编码，传值时会返回插件绑定信息

示例值:

abc123

Header 参数

jwt

string

可选

默认值:

eyJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjE4MjA3NCwidGVuYW50SWQiOjk5NDg3MDcsInVzZXJOYW1lIjoiY3R5dW4wYTFjMzI1MmI2MjQ0NzEyMTcyNTQyMjU3MSIsInRlbmFudE5hbWUiOiJtc2FwX21zZV9jc21fZGV2X21hc3RlckBxcS5jb20jcGFhczQwIiwidGVuYW50Q29kZSI6IkN0eXVuM2UxNjIxYTY3YjQwNDY0MjE3MjU0MjI1NzEiLCJidXNpVXNlcklkIjpudWxsLCJidXNpVGVuYW50SWQiOm51bGwsImJ1c2lUZW5hbnROYW1lIjpudWxsLCJhY2NvdW50VHlwZSI6MCwiaXNPd25lciI6dHJ1ZSwicmVhbE5hbWUiOiJtc2FwX21zZV9jc21fZGV2IiwicmVxU291cmNlIjoiMDEiLCJ2ZXJzaW9uTm8iOiIzLjAuMCIsInJlc1Bvb2xDb2RlIjoiYjM0MmI3N2VmMjZiMTFlY2IwYWMwMjQyYWMxMTAwMDIiLCJwcml2YXRlS2V5IjpudWxsLCJvdXRlclRlbmFudElkIjoiM2UxNjIxYTY3YjQwNDY0MmIxMDAxMDc3YzcxYmE3OWYiLCJvdXRlclVzZXJJZCI6IjBhMWMzMjUyYjYyNDQ3MTJiNmNiM2FhMGU1YTc5M2JmIiwiYWdlbnRVc2VySWQiOm51bGwsImFnZW50VGVuYW50SWQiOm51bGwsImlhdCI6MTczMjUxOTQ3NCwiaXNzIjoiZmlyc3R6dXVsIiwiZXhwIjoyMzMyNTE5NDc0fQ.XiXnJQmUSVc8I-IVY99JE5VmHMvM8dydDpD9xC5St8g

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

*/*

Body

code

integer <int32>

响应编码

可选

示例值:

200

data

object (PageInfo«InstanceDTO»)

可选

endRow

integer <int64>

可选

hasNextPage

boolean

可选

hasPreviousPage

boolean

可选

isFirstPage

boolean

可选

isLastPage

boolean

可选

list

array[object (InstanceDTO) {32}]

可选

navigateFirstPage

integer <int32>

可选

navigateLastPage

integer <int32>

可选

navigatePages

integer <int32>

可选

navigatepageNums

array[integer <int32>]

可选

integer <int32>

可选

pageNum

integer <int32>

可选

pageSize

integer <int32>

可选

pages

integer <int32>

可选

prePage

integer <int32>

可选

size

integer <int32>

可选

startRow

integer <int64>

可选

total

integer <int64>

可选

message

string

消息内容

可选

示例值:

success

requestId

string

请求唯一id

可选

示例值:

123456789-adc

示例

{
    "code": 200,
    "data": {
        "endRow": 0,
        "hasNextPage": true,
        "hasPreviousPage": true,
        "isFirstPage": true,
        "isLastPage": true,
        "list": [
            {
                "billMode": 1,
                "billModeMean": "按需",
                "bizState": 1,
                "cpuType": "Intel X86",
                "createBy": "admin",
                "expireTime": "2019-08-24T14:15:22Z",
                "gmCreate": "2019-08-24T14:15:22Z",
                "gmUpdate": "2019-08-24T14:15:22Z",
                "innerHttpPort": 27151,
                "innerHttpsPort": 27154,
                "instanceCode": "7a2828074ef6e32e041a2ef124b19e63",
                "instanceName": "test",
                "instanceNodes": [
                    {
                        "azId": "cn-hua-dong-b",
                        "azName": "华东区",
                        "ecsId": "123abc",
                        "hostName": "agw-host-1",
                        "instanceCode": 123,
                        "ip": "192.168.21.21",
                        "ipv6": "240e:8901:3500::/64",
                        "port": 80,
                        "spuInstDeployId": 1,
                        "sslPort": 443,
                        "vpcIp": "192.168.21.21",
                        "vpcIpv6": "240e:8901:3500::/64"
                    }
                ],
                "instanceStatus": "abnormal",
                "instanceVersion": "1.10.0",
                "isAuthorized": false,
                "isPluginBind": false,
                "operationControl": {
                    "isCreateInstanceOpen": true,
                    "isDeleteInstanceOpen": true,
                    "isEnableIpv6": false,
                    "isEnableUpgrade": false,
                    "isExpandInstanceOpen": true,
                    "isPayToSubscriptionOpen": true,
                    "isRenewInstanceOpen": true,
                    "isShrinkInstanceOpen": true,
                    "isSubscriptionToPayOpen": true
                },
                "projectId": 1,
                "projectName": "default",
                "regionCode": "123456abc",
                "regionName": "beijing",
                "securityGroupName": "security-group",
                "skuCode": "agw_basic",
                "spuCode": "AGW",
                "subnetName": "subnet-name",
                "tenantCode": "agw",
                "tenantId": 1,
                "tenantName": "tom",
                "vpcId": 1234,
                "vpcName": "vpc-test",
                "vpcUuid": "abc123"
            }
        ],
        "navigateFirstPage": 0,
        "navigateLastPage": 0,
        "navigatePages": 0,
        "navigatepageNums": [
            0
        ],
        "nextPage": 0,
        "pageNum": 0,
        "pageSize": 0,
        "pages": 0,
        "prePage": 0,
        "size": 0,
        "startRow": 0,
        "total": 0
    },
    "message": "success",
    "requestId": "123456789-adc"
}

🟠401没有权限

🟠403禁止访问

🟠404记录不存在