全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询已导入KDMP实例列表

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:DescribeInstanceList。
Version String
公共参数,本接口取值:2024-01-01。
InstanceId String

指定实例ID查询。

DatabaseType String

指定数据库类型进行筛选。

InstanceRegion String

指定实例机房进行筛选。

InstanceName String

指定监控大盘类型查找。

Ip String

指定实例Ip进行查找。

Search String

支持按实例ID,实例名称,Ip地址模糊查找。

Page Int

页数,从1开始,默认为1。

PageSize Int

每页返回数据条目数。默认为10。

返回参数

参数名称
类型
描述
RequestId String
示例值:e9fb1317-8cdf-449d-8a4a-fb5526a893eb
Data Object
Page Int
示例值:1
PageSize Int
示例值:10
TotalCount Int
示例值:4
InstanceList Object[]
InstanceId String
示例值:5c6b65c0-c6d7-464a-85de-259ce0684075
InstanceName String
示例值:sunkai_redis_created_by_ktrove_20240131131549420
DmpStatus String
示例值:normal
InstanceSource String
示例值:kscdb
InstanceRegion String
示例值:cn-qingyangtest-1
DatabaseType String
示例值:Redis
DatabaseVersion String
示例值:5.0
Mode String
示例值:singledatanode
Ips String
示例值:10.8.8.219
Port Int
示例值:55248
Description String
ImportTime String
示例值:2024-01-31 13:27:03

请求示例

curl -X GET
'http://dmp.api.ksyun.com/?Action=DescribeInstanceList&Version=2024-01-01&InstanceId=xxx&DatabaseType=xxx&InstanceRegion=xxx&InstanceName=xxx&Ip=xxx&Search=xxx&Page=xxx&PageSize=xxx'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/json'
-H 'host: dmp.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'

返回示例

JSON格式

{
"RequestId":"e9fb1317-8cdf-449d-8a4a-fb5526a893eb",
"Data":{
"Page":1,
"PageSize":10,
"TotalCount":4,
"InstanceList":[
{
"InstanceId":"5c6b65c0-c6d7-464a-85de-259ce0684075",
"InstanceName":"sunkai_redis_created_by_ktrove_20240131131549420",
"DmpStatus":"normal",
"InstanceSource":"kscdb",
"InstanceRegion":"cn-qingyangtest-1",
"DatabaseType":"Redis",
"DatabaseVersion":"5.0",
"Mode":"singledatanode",
"Ips":"10.8.8.219",
"Port":55248,
"Description":null,
"ImportTime":"2024-01-31 13:27:03"
}
]
}
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码
错误信息
Http状态码
描述
NotSupportedTypeNotSupportedType.400不支持的数据库类型。
纯净模式常规模式

纯净模式

点击可全屏预览文档内容