华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 snapshots Array of Snapshots objects 快照对象列表。 count Integer 快照对象列表总数 project_id String 项目ID。 cluster_id String 集群ID。 表4 Snapshots 参数 参数类型 描述 id String 快照ID。 name String 快照名称。 description String 快照描述。 started String 快照创建的日期时间，格式为 ISO8601: YYYY-MM-DDThh:mm:ssZ。 updated String 快照记录更新时间，格式为 ISO8601: YYYY-MM-DDThh:mm:ssZ。 size Double 快照大小，单位 GB。 status String 快照状态： CREATING：创建中。 AVAILABLE：可用。 UNAVAILABLE：不可用,备份失败。 RESTORING: 恢复中。 type String 快照创建类型。其中： MANUAL为手动快照。 AUTO为自动快照。 cluster_id String 快照对应的集群ID。 cluster_name String 快照对应的集群名称。 backup_key String 备份产生的Key。 prior_backup_key String 增量快照使用前一个快照的BakupKey。当取值为FULL时表示这是一个全量快照。 base_backup_key String 对应全量快照的BackupKey。 backup_device String 备份介质。 total_backup_size Long 快照累计大小，表示从全量开始到当前增量的累计大小。单位KB base_backup_name String 对应全量快照名称。 support_inplace_restore Boolean 是否支持恢复至原集群。 fine_grained_backup Boolean 是否是细粒度备份。 fine_grained_backup_detail FineGrainedSnapshotDetail object 细粒度备份信息。 guest_agent_version String 集群guestAgent版本号。 cluster_status String 集群状态 AVAILABLE：可用 UNAVAILABLE：不可用 FROZEN：已冻结 bak_expected_start_time String 预计快照开始时间。 bak_keep_day Integer 备份保留天数。 bak_period String 集群策略。 db_user String 备份用户。 datastore DataStore object 数据库版本 progress String 备份进度。 backup_level String 备份级别 cluster schema 表5 FineGrainedSnapshotDetail 参数 参数类型 描述 database String 备份数据库。 schema_list Array of String 备份模式集合。 table_list Array of String 备份表集合。 表6 DataStore 参数 参数类型 描述 type String 数据库类型。 version String 数据库版本。

URI GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 cluster_id 是 String 集群ID。获取方法，请参见获取集群ID。 表2 Query参数 参数 是否必选 参数类型 描述 sort_key 否 String 排序字段，排序字段需与排序规则一一对应。 可选字段：name、clusterName、startTime sort_dir 否 String 排序规则： ASC DESC offset 否 Integer 偏移量，从第几条开始查询。 limit 否 Integer 查询条数。

响应示例 查询事件列表成功。 { "events" : [ { "category" : "management", "description" : "集群%s删除成功", "name" : "deleteClusterSuccess", "severity" : "normal", "status" : 2, "subject" : "DWS服务事件通知", "context" : "集群test-ty-820-1006删除成功", "event_id" : "f63ccf96-e3e0-474a-835a-fd1a779f68bd", "display_name" : "集群删除成功", "name_space" : "dws", "source_type" : "cluster", "occur_time" : 1664331248330, "project_id" : "4cf650fd46704908aa071b4df2453e1e", "source_id" : "9defa0ce-b11c-47b2-abbc-5cad09ced772", "source_name" : "test-ty-820-1006" } ], "count" : 1}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 events Array of EventResponse objects 事件详情列表。 count Integer 事件总数。 表4 EventResponse 参数 参数类型 描述 category String 事件类别。 description String 事件描述。 event_id String 事件ID。 name String 事件定义名称。 display_name String 事件显示名称。 name_space String 所属服务。 severity String 事件级别。 source_type String 事件源类别。 occur_time Long 时间。 project_id String 项目ID。 source_id String 事件源ID。 source_name String 事件源名称。 status Integer 状态。 subject String 事件主题。 context String 事件信息。

URI GET /v2/{project_id}/event-specs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 spec_name 否 String 事件配置名称。 category 否 String 事件类别。 severity 否 String 事件级别。 source_type 否 String 事件源类别。 tag 否 String 事件标签。 offset 否 String 当前页。默认取值为1，最大支持10000。 limit 否 String 显示条数。最大支持1000。

响应参数 表3 响应Body参数 参数 参数类型 描述 count Integer 事件配置总数。 event_specs Array of EventSpecResponse objects 事件配置列表。 表4 EventSpecResponse 参数 参数类型 描述 id String 事件配置ID。 name String 事件配置定义名称。 display_name String 事件配置显示名称。 description String 事件配置描述。 subject String 事件主题。 category String 事件类别。 severity String 事件级别。 source_type String 事件源类型。 name_space String 所属服务。

响应示例 状态码： 200 集群查询事件配置成功。 { "event_specs" : [ { "id" : "fa6e1502-9d08-48c7-900c-26d3b5bd6078", "name" : "configureMRSExtDataSourcesSuccess", "description" : "配置集群%s的MRS外部数据源成功", "subject" : "DWS服务事件通知", "category" : "management", "severity" : "normal", "display_name" : "配置集群的MRS外部数据源成功", "source_type" : "cluster", "name_space" : "dws" } ], "count" : 1}

响应示例 状态码： 200 集群查询事件配置成功。 { "event_subscriptions" : [ { "id" : "4d62f33b-b9ee-41d3-b1bc-67e54b2239f9", "name" : "00", "category" : "", "severity" : "", "tag" : "", "enable" : 1, "language" : "zh-cn", "source_type" : "", "source_id" : "", "project_id" : "4cf650fd46704908aa071b4df2453e1e", "name_space" : "DWS", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:CGS", "notification_target_name" : "CGS", "notification_target_type" : "SMN", "time_zone" : "GMT+08:00" } ], "count" : 1}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 事件订阅总数。 event_subscriptions Array of EventSubscriptionResponse objects 事件订阅详情列表。 表4 EventSubscriptionResponse 参数 参数类型 描述 id String 订阅ID。 name String 订阅名称。 source_type String 事件源类型。 source_id String 事件源ID。 category String 事件类别。 severity String 事件级别。 tag String 事件标签。 enable Integer 是否开启订阅 ： 1为开启 0为关闭 project_id String 项目ID。 name_space String 所属服务。 notification_target String 消息通知主题地址。 notification_target_name String 消息通知主题名称。 notification_target_type String 消息通知类型。 language String 语言。 time_zone String 时区。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 事件订阅名称。 source_type 否 String 事件源类型支持： cluster backup disaster-recovery source_id 否 String 事件源ID。 category 否 String 事件类别支持： management monitor security system alarm 枚举值：多个枚举值使用 “, ”分隔。 severity 否 String 事件级别支持normal，warning。 tag 否 String 事件标签。 enable 否 Integer 是否开启订阅： 1为开启。 0为关闭。 notification_target 是 String 消息通知地址。 notification_target_name 是 String 消息主题名称。 notification_target_type 是 String 消息通知类型只支持SMN。 time_zone 否 String 时区。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 订阅ID。 name String 订阅名称。 source_type String 事件源类型。 source_id String 事件源ID。 category String 事件类别。 severity String 事件级别。 tag String 事件标签。 enable Integer 是否开启订阅 ： 1为开启 0为关闭 project_id String 项目ID。 name_space String 所属服务。 notification_target String 消息通知主题地址。 notification_target_name String 消息通知主题名称。 notification_target_type String 消息通知类型。 language String 语言。 time_zone String 时区。

请求示例 开启名为zrf-test-66的正常和警告事件订阅，并选择地址为“urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete”的SMN消息主题“dws-test-nodelete”： https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/event-subs{ "severity" : "normal,warning", "source_id" : "", "source_type" : "", "tag" : "", "category" : "", "enable" : 1, "name" : "zrf-test-66", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", "notification_target_name" : "dws-test-nodelete", "notification_target_type" : "SMN", "time_zone" : "GMT+08:00"}

响应示例 状态码： 200 { "id" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b", "name" : "zrf-test-66", "category" : "", "severity" : "normal,warning", "tag" : "", "enable" : 1, "language" : "zh-cn", "source_type" : "", "source_id" : "", "project_id" : "4cf650fd46704908aa071b4df2453e1e", "name_space" : "DWS", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", "notification_target_name" : "dws-test-nodelete", "notification_target_type" : "SMN", "time_zone" : "GMT+08:00"}

请求示例 更新zrf-test-66事件订阅，事件类别修改为正常和警告，SMN消息主题dws-test-nodelete地址更新为“urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete”： https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/event-subs/41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b{ "severity" : "normal,warning", "source_id" : "", "source_type" : "", "tag" : "", "category" : "", "enable" : 1, "name" : "zrf-test-66", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", "notification_target_name" : "dws-test-nodelete", "notification_target_type" : "SMN"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 订阅ID。 name String 订阅名称。 source_type String 事件源类型。 source_id String 事件源ID。 category String 事件类别。 severity String 事件级别。 tag String 事件标签。 enable Integer 是否开启订阅： 1为开启 0为关闭 project_id String 项目ID。 name_space String 所属服务。 notification_target String 消息通知主题地址。 notification_target_name String 消息通知主题名称。 notification_target_type String 消息通知类型。 language String 语言。 time_zone String 时区。

响应示例 状态码： 200 { "id" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b", "name" : "zrf-test-66", "category" : "", "severity" : "normal,warning", "tag" : "", "enable" : 1, "language" : "zh-cn", "source_type" : "", "source_id" : "", "project_id" : "4cf650fd46704908aa071b4df2453e1e", "name_space" : "DWS", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", "notification_target_name" : "dws-test-nodelete", "notification_target_type" : "SMN", "time_zone" : "GMT+08:00"}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 事件订阅名称。 source_type 否 String 事件源类型支持 cluster backup disaster-recovery source_id 否 String 事件源ID。 category 否 String 事件类别支持 management monitor security system alarm 枚举值：多个枚举值使用 “, ”分隔。 severity 否 String 事件级别支持normal和warning。 tag 否 String 事件标签。 enable 否 Integer 是否开启订阅 ： 1为开启 0为关闭 notification_target 是 String 消息通知地址。 notification_target_name 是 String 消息主题名称。 notification_target_type 是 String 消息通知类型只支持SMN。

响应示例 { "data_sources": [ { "id": "8010dbc0-c1d2-48d6-87eb-3229f9195fed", "name": "tes54", "type": "OBS", "connect_info": "gaussdb", "user_name": "DWSAccessOBS", "configure_status": "300", "created": "2022-10-30T07:38:33", "extend_properties": { }, "description": "xxx", "fail_reason": "" } ], "project_id": "0536cdee2200d5912f7cc00b877980f1", "cluster_id": "a07cb2f7-b17e-4d95-923b-a33d0c884d37", "type": "OBS", "count": 5}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 id String 订阅ID。 name String 订阅名称。 source_type String 事件源类型。 source_id String 事件源ID。 category String 事件类别。 severity String 事件级别。 tag String 事件标签。 enable Integer 是否开启订阅 ： 1为开启 0为关闭 project_id String 项目ID。 name_space String 所属服务。 notification_target String 消息通知主题地址。 notification_target_name String 消息通知主题名称。 notification_target_type String 消息通知类型。 language String 语言。 time_zone String 时区。

响应示例 状态码： 200 { "id" : "41eb162b-cd3b-4c66-88d0-0c2c17fdfc2b", "name" : "zrf-test-66", "category" : "", "severity" : "normal,warning", "tag" : "", "enable" : 1, "language" : "zh-cn", "source_type" : "", "source_id" : "", "project_id" : "4cf650fd46704908aa071b4df2453e1e", "name_space" : "DWS", "notification_target" : "urn:smn:cn-north-7:4cf650fd46704908aa071b4df2453e1e:dws-test-nodelete", "notification_target_name" : "dws-test-nodelete", "notification_target_type" : "SMN", "time_zone" : "GMT+08:00"}

请求示例 创建名为test154的OBS数据源，用户名为“DWSAccessOBS”，连接gaussdb数据库： POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/ext-data-sources{ "type": "OBS", "data_source_name": "test154", "user_name": "DWSAccessOBS", "connect_info": "gaussdb", "description": "xxx"}

请求示例 修改ID为“d303f19c-fbd1-4716-ae04-07d1ff358f22”数据源，委托名修改为“DWSAccessOBS”： PUT https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/ext-data-sources/d303f19c-fbd1-4716-ae04-07d1ff358f22{ "reconfigure":{ "reboot": false, "agency": "DWSAccessOBS" }}

URI PUT /v1.0/{project_id}/clusters/{cluster_id}/ext-data-sources/{ext_data_source_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 cluster_id 是 String 集群ID。获取方法，请参见获取集群ID。 ext_data_source_id 是 String 数据源配置ID。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 workload_status WorkloadStatus object 资源管理状态。 workload_res_code Integer 返回状态。 workload_res_str String 状态描述。 表3 WorkloadStatus 参数 参数类型 描述 workload_switch String 资源管理开关。 max_concurrency_num String 最大并发数。

响应示例 { "records": [ { "result": "RUNNING", "cluster_id": "a07cb2f7-b17e-4d95-923b-a33d0c884d37", "exector_time": "2022-10-31T09:11:31", "begin_time": "2022-10-31T09:09:55", "end_time": "2022-10-31T09:19:55", "bucket_name": "g30022255", "location_prefix": "test" } ], "count": 1, "cluster_id": "a07cb2f7-b17e-4d95-923b-a33d0c884d37"}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 records Array of AuditDumpRecord objects 审计日志列表。 cluster_id String 集群ID。 count Integer 总数。 表3 AuditDumpRecord 参数 参数类型 描述 cluster_id String 集群ID。 exector_time String 执行时间。 begin_time String 开始时间。 end_time String 结束时间。 bucket_name String 桶名。 location_prefix String OBS路径。 result String 结果状态。 failed_reason String 失败原因。

URI DELETE /v2/{project_id}/clusters/{cluster_id}/workload/queues 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法，请参见获取项目ID。 cluster_id 是 String 集群ID。获取方法，请参见获取集群ID。 表2 Query参数 参数 是否必选 参数类型 描述 logical_cluster_name 否 String 逻辑集群名称。 workload_queue_name 是 String 资源池名称。

请求示例 开启资源管理，并设置最大并发数为5： POST https://{Endpoint} /v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/workload{ "workload_status":{ "workload_switch":"on", "max_concurrency_num":"5" }}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 workload_status 否 WorkloadStatus object 资源管理状态。 表3 WorkloadStatus 参数 是否必选 参数类型 描述 workload_switch 是 String 开关。取值：on/off。 max_concurrency_num 否 String 最大并发数。 -1~2147483647 范围之间的整数，其中-1/0表示不限制。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 告警配置总数。 alarm_configs Array of AlarmConfigResponse objects 告警配置列表。 表4 AlarmConfigResponse 参数 参数类型 描述 id String 告警配置ID。 alarm_id String 告警ID。 alarm_name String 告警名称。 name_space String 所属服务。 alarm_level String 告警级别。其中包括： urgent：紧急 important：重要 minor：次要 prompt：提示 is_user_visible String 用户是否可见。 is_converge String 是否覆盖。 converge_time Integer 覆盖时间。 is_maintain_visible String 运维是否可见。