导出云DBA首页实例列表 - ExportInstanceList
功能介绍
导出云DBA首页实例列表。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
das::listInstances
read
-
-
-
-
URI
POST /v3/{project_id}/instance/export-instance-list
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
engine_type |
是 |
String |
参数解释： 数据库引擎类型。 约束限制： 不涉及。 取值范围： 不涉及 默认取值： 不涉及 |
|
engine_group |
是 |
String |
参数解释： 数据库引擎类型。 约束限制： 不涉及。 取值范围： 不涉及 默认取值： 不涉及 |
|
instance_status |
是 |
String |
参数解释： 实例状态。 约束限制： 不涉及。 取值范围： normal:正常，abnormal:异常，指标异常:metricAbnormal, 磁盘不足:dataDiskFull, all:所有 默认取值： 不涉及 |
|
order_value |
否 |
String |
参数解释： 排序条件。 约束限制： 不涉及。 取值范围： 不涉及 默认取值： 不涉及 |
|
metric_names |
否 |
Arrays of String |
参数解释： 指标名称。 约束限制： 不涉及。 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释： 总数。 取值范围： 不涉及。 |
|
instance_infos |
Arrays of 表4 Objects |
参数解释： 实例信息列表。 取值范围： 不涉及。 |
请求示例
POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instance/export-instance-list
{
"engine_type": "mysql",
"engine_group": "mysql",
"instance_status": "all",
"metric_names": [
"qps",
"tps",
"mem_usage",
"cpu_usage",
"connection_total_count",
"connection_active_count"
]
}
响应示例
状态码： 200
Success.
{
"instance_infos": [
{
"instance_id": "5c59fa7d6f09456b947f32922f9aeda1in01",
"instance_name": "DAS-MYSQL-AT",
"instance_status": "ACTIVE",
"metrics": {
"mem_usage": 48.2,
"qps": 3.88,
"tps": 0,
"connection_total_count": 16,
"cpu_usage": 5.07,
"connection_active_count": 2
}
}
],
"total": 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Success. |
|
400 |
Client error. |
|
500 |
Server error. |
错误码
请参见错误码。
