云服务器内容精选

  • URI GET /v1/{project_id}/pools/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定每一页查询返回的最大条目数,默认为200。 offset 否 Integer 分页列表的起始页,默认为0。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of PoolTag objects 资源标签的列表。 表4 PoolTag 参数 参数类型 描述 key String 资源类型的标签 values Array of strings 资源类型的标签值 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。
  • 响应示例 action为filter { "resources": [ { "resource_detail": null, "resource_id": "cdfs_cefs_wesas_12_dsad", "resource_name": "resouece1", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ], "total_count": 1000} action为count { "total_count": 1000}
  • 请求参数 表2 请求参数 参数名称 类型 是否必选 说明 tags Array of tag objects 否 包含标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。 limit Integer 否 查询记录数(action为count时无此参数)如果action为filter默认为1000,limit最多为1000,不能为负数,最小值为1 offset Integer 否 (索引位置), 从offset指定的下一条数据开始查询。 查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数(action为count时无此参数)如果action为filter默认为0,必须为数字,不能为负数 action String 是 操作标识(仅限于filter,count):filter(过滤),count(查询总条数) 如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可。 matches Array of match objects 否 搜索字段,key为要匹配的字段,当前仅支持resource_name。value为匹配的值。此字段为固定字典值。 表3 tag字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做校验) values 是 Array of strings 值列表。每个值最大长度255个unicode字符,如果values为空列表,则表示any_value。 value之间为或的关系: 能查到匹配任意一个value的资源,如,资源A有val1的tag,B有val2的tag,用values={val1,val2}能过滤查询到资源A和B。 表4 match字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 键。当前仅限定为resource_name value 是 String 值。每个值最大长度255个unicode字符。
  • 请求示例 过滤查询VPC资源实例,action为filter,从第1条数据开始查询,单次查询最多返回100条,用matches和tags过滤查询。 POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action{ "offset": "0", "limit": "100", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] } ]} 过滤计数VPC资源实例,action为count,用matches和tags过滤计数。 POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action{ "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ]}
  • 响应参数 表5 响应参数 名称 参数类型 说明 resources Array of resource objects resource对象列表,请参见表6。 total_count Integer 总记录数 表6 resource对象 名称 参数类型 说明 resource_id String 资源ID resource_detail Object 资源详情。 资源对象,用于扩展。默认为空 tags Array of tag objects 标签列表,没有标签默认为空数组,参见表7 resource_name String 资源名称,没有默认为空字符串 表7 tag字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 键。最大长度128个unicode字符。 key不能为空。(搜索时不对此参数做校验) value 是 String 值列表。每个值最大长度255个unicode字符,如果values为空列表,则表示any_value。 value之间为或的关系: 能查到匹配任意一个value的资源,如,资源A有val1的tag,B有val2的tag,用values={val1,val2}能过滤查询到资源A和B。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 tags Array of ResourceTag objects tag对象列表 request_id String 请求ID 表3 ResourceTag 参数 参数类型 描述 key String 功能说明:标签键。 约束:同一资源的key值不能重复。 最小长度:1 最大长度:128 value String 功能说明:标签值。 最大长度:255 状态码: 400 表4 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码: 401 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码: 403 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码: 404 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 tags Array of ListTag objects tag对象列表 表3 ListTag 参数 参数类型 描述 key String 功能说明:标签键 约束:key不能为空 最小长度:1 最大长度:127 values Array of strings 功能描述:标签值列表。 如果values为空列表,则表示any_value。value之间为或的关系。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 最小长度:1 最大长度:999 状态码: 401 表5 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 最小长度:1 最大长度:999 状态码: 403 表6 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 最小长度:1 最大长度:999 状态码: 404 表7 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 最小长度:1 最大长度:999 状态码: 409 表8 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 最小长度:1 最大长度:999 状态码: 500 表9 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 最小长度:1 最大长度:999
  • 响应参数 表2 响应参数 参数名称 类型 说明 tags Array of tag objects tag对象列表,请参见表3。 表3 tag对象 属性 类型 说明 key String 标签名称。 不能为空。 长度不超过128个字符(当前控制台操作key长度不超过36个字符)。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 value String 标签值。 长度不超过255个字符(当前控制台操作value长度不超过43个字符)。 由英文字母、数字、下划线、点、中划线、中文字符组成。