云服务器内容精选

  • 请求示例 创建名称为rg_test,且资源分组添加资源方式为TAG的资源分组。 { "group_name" : "rg_test", "enterprise_project_id" : "0", "type" : "TAG", "tags" : [ { "key" : "key1", "value" : "value1" } ], "association_ep_ids" : [ "d61d4705-5658-42f5-8e0c-70eb34d17b02" ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token 最小长度:1 最大长度:16384 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 资源分组的名称,只能为字母、数字、汉字、-、_,最大长度为128 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ enterprise_project_id 否 String 资源分组归属企业项目ID 正则匹配:^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ type 否 String 资源分组添加资源方式,取值只能为EPS(同步企业项目),TAG(标签动态匹配),不传为手动添加 正则匹配:^(EPS|TAG|Manual|COMB)$ tags 否 Array of ResourceGroupTagRelation objects 标签动态匹配时的关联标签,type为TAG时必传 数组长度:1 - 10 association_ep_ids 否 Array of strings 该资源分组内包含的资源来源的企业项目ID,type为EPS时必传 数组长度:1 - 10 表4 ResourceGroupTagRelation 参数 是否必选 参数类型 描述 key 是 String 键 最小长度:1 最大长度:36 value 否 String 值 最小长度:1 最大长度:42
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 group_id String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 查询成功 { "dimensions" : [ { "name" : "disk", "value" : "2e84018fc8b4484b94e89aae212fe615", "origin_value" : "vda" }, { "name" : "disk", "value" : "6a1b2de69eeb9a037ea23de6b529394d", "origin_value" : "vdc" } ], "count" : 10 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 dimensions Array of AgentDimension objects 维度信息 数组长度:0 - 2147483647 count Integer 维度信息总数 最小值:0 最大值:2147483647 表5 AgentDimension 参数 参数类型 描述 name String 维度名称,枚举类型,类型有: mount_point:挂载点, disk:磁盘, proc:进程, gpu:显卡, raid: RAID控制器 枚举值: mount_point disk proc gpu raid value String 维度值,32位字符串,如:2e84018fc8b4484b94e89aae212fe615 最小长度:32 最大长度:32 origin_value String 实际维度信息,字符串,如:vda。 最小长度:1 最大长度:1024 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:256 error_msg String 错误信息 最小长度:0 最大长度:256 request_id String 请求id 最小长度:0 最大长度:256 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:256 error_msg String 错误信息 最小长度:0 最大长度:256 request_id String 请求id 最小长度:0 最大长度:256 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:256 error_msg String 错误信息 最小长度:0 最大长度:256 request_id String 请求id 最小长度:0 最大长度:256
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值:application/json; charset=UTF-8 最小长度:1 最大长度:64 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:16384
  • URI GET /v2/{project_id}/instances/{instance_id}/agent-dimensions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。 最小长度:1 最大长度:64 instance_id 是 String 资源ID,如:4270ff17-aba3-4138-89fa-820594c39755。 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 是 String 维度名称,枚举类型,类型有: mount_point:挂载点, disk:磁盘, proc:进程, gpu:显卡, raid: RAID控制器, 枚举值: mount_point disk proc gpu raid dim_value 否 String 维度值,32位字符串,如:2e84018fc8b4484b94e89aae212fe615。 最小长度:32 最大长度:32 offset 否 Integer 分页偏移量 最小值:0 最大值:2147483647 缺省值:0 正则匹配:^(0|[1-9][0-9]*)$ limit 否 Integer 分页大小 最小值:1 最大值:1000 缺省值:1000 正则匹配:^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1000)$
  • 响应示例 状态码: 200 OK { "resource_groups" : [ { "group_name" : "group1", "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "0", "type" : "Manual" }, { "group_name" : "band", "type" : "EPS", "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "d61d4705-5658-42f5-8e0c-70eb34d17b02" }, { "group_name" : "group2", "type" : "TAG", "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "0" } ], "count" : 3 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 资源分组总数 最小值:0 最大值:1000 resource_groups Array of OneResourceGroupResp objects 资源分组列表 数组长度:0 - 100 表5 OneResourceGroupResp 参数 参数类型 描述 group_name String 资源分组的名称 正则匹配:^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ group_id String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 最小长度:2 最大长度:24 create_time String 资源分组的创建时间 enterprise_project_id String 资源分组归属企业项目ID 正则匹配:^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ type String 资源分组添加资源方式,取值只能为EPS(同步企业项目),TAG(标签动态匹配),Manual(手动添加) 枚举值: EPS TAG Manual 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • URI GET /v2/{project_id}/resource-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 归属企业项目ID 正则匹配:^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ group_name 否 String 资源分组名称,支持模糊查询 最小长度:1 最大长度:128 group_id 否 String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 最小长度:2 最大长度:24 offset 否 Integer 分页查询时查询的起始位置,表示从第几条数据开始,默认为0 最小值:0 最大值:10000 limit 否 Integer 分页查询时每页的条目数,取值[1,100],默认值为100 最小值:1 最大值:100 type 否 String 资源分组添加资源方式,取值只能为EPS(同步企业项目),TAG(标签动态匹配),Manual(手动添加),不传代表查询所有资源分组类型,COMB(智能添加-组合匹配) 枚举值: EPS TAG Manual COMB origin_flag 否 String 来源标识,取值只能为resourcegroup(资源分组),monitoroverview(监控概览),不传默认为资源分组 枚举值: resourcegroup monitoroverview
  • 响应示例 状态码: 200 OK { "widget_id" : "wg1234567890123456789012", "metrics" : [ { "namespace" : "SYS.E CS ", "dimensions" : { "name" : "instance_id", "filter_type" : "specific_instances", "values" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ] }, "metric_name" : "cpu_util", "alias" : [ "cpuutilalias" ], "extra_info" : { "origin_metric_name" : "cpu_util", "metric_prefix" : "cpu", "metric_type" : "type", "custom_proc_name" : "app.sh" } } ], "view" : "view", "metric_display_mode" : "single", "threshold" : 0.7, "threshold_enabled" : true, "title" : "widget_title", "properties" : { "filter" : "topN", "topN" : 100, "order" : "desc" }, "location" : { "left" : 0, "top" : 0, "width" : 4, "height" : 3 }, "unit" : "%", "create_time" : 1111111111111 }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 widget_id String 视图id 正则匹配:^wg([a-z]|[A-Z]|[0-9]){22}$ metrics Array of WidgetMetric objects 指标列表 数组长度:1 - 200 title String 监控视图标题 最小长度:1 最大长度:128 正则匹配:^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|:|;|\(|\)|\.|~|(|))+$ threshold Double 监控视图指标的阈值 最小值:0 最大值:1.7976931348623157E308 threshold_enabled Boolean 阈值是否展示,true:展示,false:不展示 view String 监控视图图表类型, bar条形图,line折线图,bar_chart柱状图,table表格,circular_bar环形柱状图,area_chart面积图 枚举值: bar line bar_chart table circular_bar area_chart metric_display_mode String 指标展示类型,single 单指标展示,multiple 多指标展示 枚举值: single multiple properties properties object 额外信息 location location object 监控视图图表坐标 unit String 单位 create_time Long 监控看板创建时间 最小值:1111111111111 最大值:9999999999999 表4 WidgetMetric 参数 参数类型 描述 namespace String 服务维度 最小长度:3 最大长度:32 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$ dimensions DimensionInfo object 维度信息列表 metric_name String 指标名称 最小长度:1 最大长度:96 正则匹配:^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$ alias Array of strings 监控视图的指标别名列表 最小长度:1 最大长度:128 数组长度:0 - 200 extra_info ExtraInfo object 指标信息 表5 DimensionInfo 参数 参数类型 描述 name String 维度名称,多维度用逗号分隔,各服务支持的维度可参考:“服务维度名称” 最小长度:1 最大长度:131 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$ filter_type String 资源类型, all_instances: 全部资源, specific_instances: 指定资源 枚举值: all_instances specific_instances values Array of strings 维度值列表 最小长度:1 最大长度:1024 数组长度:0 - 200 表6 ExtraInfo 参数 参数类型 描述 origin_metric_name String 指标名称 最小长度:1 最大长度:4096 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_prefix String 指标名称前缀 最小长度:1 最大长度:4096 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ metric_type String 指标类型 最小长度:1 最大长度:32 正则匹配:^([a-z]|[A-Z]|[0-9]|_|-|~|\.|/|:)*$ custom_proc_name String 自定义进程名称 最小长度:1 最大长度:250 表7 properties 参数 参数类型 描述 filter String 聚合类型,目前只有TopN这一种类型,折线图不支持该参数 枚举值: topN topN Integer Top前N个;折线图时为随机展示的时序数据条数 最小值:1 最大值:2147483647 缺省值:100 order String 排序字段,asc正序,desc倒序,折线图不支持该参数 枚举值: asc desc 表8 location 参数 参数类型 描述 top Integer 监控视图的上坐标 最小值:0 最大值:2147483647 left Integer 监控视图的左坐标 最小值:0 最大值:9 width Integer 监控视图图表宽度 最小值:3 最大值:12 height Integer 监控视图图表高度 最小值:3 最大值:2147483647 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json 缺省值:application/json;charset=UTF-8 最小长度:1 最大长度:64 X-Auth-Token 是 String 用户Token。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:1 最大长度:16000
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 succeed_count Integer 成功删除的资源数目 最小值:0 最大值:1000 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256
  • URI POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-delete 表1 路径参数 参数 是否必选 参数类型 描述 group_id 是 String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 最小长度:2 最大长度:24 project_id 是 String 租户ID 最小长度:1 最大长度:64