云服务器内容精选

  • URI GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度:1 最大长度:64 group_id 是 String 资源分组ID,以rg开头,后跟22位由字母或数字组成的字符串 最小长度:2 最大长度:24 service 是 String 服务类别,如SYS.ECS 最小长度:3 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 否 String 资源维度信息,多个维度按字母序使用逗号分割 最小长度:1 最大长度:131 limit 否 String 分页查询时每页的条目数,取值[1,100],默认值为100 最小长度:1 最大长度:100 offset 否 Integer 分页查询时查询的起始位置,表示从第几条数据开始,默认为0 最小值:0 最大值:10000 status 否 String 按状态信息进行过滤,取值只能为health(已设置告警规则且无告警触发的资源)、unhealthy(已设置告警规则且有告警触发的资源)、no_alarm_rule(未设置告警规则的资源) 枚举值: health unhealthy no_alarm_rule dim_value 否 String 资源维度值,不支持模糊匹配,但是多维度资源可以只指定一个维度值 最小长度:1 最大长度:1027 tag 否 String 资源的标签信息,格式:"[key]":"[value]",样例参考:"ssss":"1111" 最小长度:0 最大长度:500 extend_relation_id 否 String 企业项目ID 最小长度:0 最大长度:128
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 资源总数 最小值:0 最大值:10000 resources Array of GetResourceGroupResources objects 资源分组资源列表 数组长度:0 - 100 表5 GetResourceGroupResources 参数 参数类型 描述 status String 资源健康状态,取值为health(已设置告警规则且无告警触发的资源)、unhealthy(已设置告警规则且有告警触发的资源)、no_alarm_rule(未关联告警规则) 枚举值: health unhealthy no_alarm_rule dimensions Array of Dimension objects 资源的维度信息 数组长度:1 - 4 表6 Dimension 参数 参数类型 描述 name String 资源维度,如:弹性云服务器,则维度为instance_id;目前最大支持4个维度,各服务资源的指标维度名称可查看:“服务指标维度”。 正则匹配:^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ value String 资源维度值,为资源的实例ID,如:4270ff17-aba3-4138-89fa-820594c39755。 正则匹配:^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$ 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 404 表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
  • 响应示例 状态码: 200 OK { "count" : 1000, "resources" : [ { "status" : "health", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 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 association_ep_ids Array of strings 该资源分组内包含的资源来源的企业项目ID,type为EPS时必传 数组长度:1 - 1 tags Array of ResourceGroupTagRelation objects 标签动态匹配时的关联标签,type为TAG时该字段不为空 数组长度:1 - 10 表4 ResourceGroupTagRelation 参数 参数类型 描述 key String 键 最小长度:1 最大长度:36 value String 值 最小长度:1 最大长度:42 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度:0 最大长度:256 error_msg String 请求异常信息 最小长度:0 最大长度:256 request_id String 请求ID 最小长度:0 最大长度:256 状态码: 403 表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
  • 响应示例 状态码: 200 OK { "group_name" : "band", "type" : "TAG", "tags" : [ { "key" : "Resource", "value" : "VPC" }, { "key" : "Usage", "value" : "Tmp" } ], "create_time" : "2006-01-02T15:04:05.000Z", "group_id" : "rg0123456789xxxx", "enterprise_project_id" : "0" }
  • 请求消息 请求参数 表2 请求参数 名称 类型 是否必选 说明 group_name String 是 资源分组的名称,长度为1-128,只能包含0-9/a-z/A-Z/_/-或汉字。如:ResourceGroup-Test01。 resources Array of objects 是 创建的资源分组选择一个或者多个资源。 详细参数说明请参见表3。 表3 resources字段数据结构说明 名称 参数类型 是否必选 说明 namespace String 是 资源命名空间,如弹性云服务器的资源命名空间为:SYS.ECS,各服务命名空间可查看支持监控的服务列表。 dimensions Arrays of objects 是 一个或者多个资源维度。 详细参数说明请参见表4。 表4 dimensions字段数据结构说明 名称 参数类型 是否必选 说明 name String 是 资源维度,例如弹性云服务器维度为:instance_id,各资源的维度可查看支持监控的服务列表。 value String 是 资源维度值,为资源的实例ID。如:4270ff17-aba3-4138-89fa-820594c39755。 请求示例: { "group_name": "Resource-Group-Test01", "resources": [ { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "063a83da-a2b5-4630-ab6b-9b4fcfc261ea" } ] }, { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "518ace88-abde-46bf-829b-0d1f0f2fb2e9" } ] }, { "namespace": "SYS.ECS", "dimensions": [ { "name": "instance_id", "value": "675006b5-477a-4aab-948c-0aa467de9c68" } ] } ] }
  • 返回值 正常 204 异常 返回值 说明 400 Bad Request 请求错误。 401 Unauthorized 未提供认证信息,或认证信息错误。 403 Forbidden 请求页面被禁止访问。 408 Request Timeout 请求超出了服务器的等待时间。 429 Too Many Requests 当前请求过多。 500 Internal Server Error 请求未完成,服务异常。 503 Service Unavailable 系统暂时不可用,请求受限。
  • URI PUT /V1.0/{project_id}/resource-groups/{group_id} 参数说明 表1 参数说明 名称 类型 是否必选 说明 project_id String 是 项目ID。 获取方式请参见获取项目ID。 group_id String 是 资源分组ID。 请求样例: PUT https://{云监控的endpoint}/V1.0/{project_id}/resource-groups/{group_id}