云服务器内容精选

  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 quotas Object 配额列表对象。 详情请参见表3。 表3 quotas字段数据结构说明 名称 参数类型 说明 resources Array of objects 资源列表对象。 详情请参见表4。 表4 resources字段数据结构说明 名称 参数类型 说明 quota Integer 项目资源配额。 used Integer 已使用的资源数量。 type String 项目资源类型,取值范围如下: instance:实例类型资源。 正常响应样例 { "quotas" : { "resources" : [ { "quota" : 100, "used" : 1, "type" : "instance" } ] } } 异常响应 请参见异常请求结果。
  • 响应示例 状态码: 200 Success. { "total_count" : 4, "enterprise_projects" : [ { "id" : 0, "name" : "default", "description" : null, "status" : 1, "created" : null, "updated" : null }, { "id" : "5c7d11e0-3201-4558-bcce-1172137cf7e2", "name" : "sjw-eps", "description" : null, "status" : 1, "created" : "2023-06-12T02:14:28+0000", "updated" : "2023-06-12T02:14:28+0000" }, { "id" : "12093327-28dc-46c5-8ba6-d42c9236f9d6", "name" : "adf", "description" : null, "status" : 1, "created" : "2023-05-06T08:33:03+0000", "updated" : "2023-05-06T08:33:03+0000" }, { "id" : "07d90b3f-422b-40c9-b9b3-6d00d1d7a60b", "name" : "eps-test", "description" : null, "status" : 1, "created" : "2023-03-16T01:38:13+0000", "updated" : "2023-03-16T01:38:13+0000" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 enterprise_projects Array of EnterpriseProjectItem objects 企业项目信息列表。 total_count Integer 总数。 表5 EnterpriseProjectItem 参数 参数类型 描述 id String 企业项目ID。 name String 企业项目名称。 description String 描述。 status String 状态。 - 1:正常。 - 0:异常。 created String 创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 updated String 更新时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • URI GET /v3/{project_id}/enterprise-projects 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 Integer 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 quota_list Array of setQuota objects 资源列表对象。 表6 setQuota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 instance_quota Integer 实例个数配额。取值范围0~100000。(如果已经存在实例,应该大于已经存在的实例个数) vcpus_quota Integer CPU核数配额。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的cpu个数) ram_quota Integer 内存使用配额,单位为GB。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的内存数) 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 quota_list 是 Array of setQuota objects 资源列表对象。 表4 setQuota 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 instance_quota 否 Integer 实例个数配额。取值范围0~100000。(如果已经存在实例,应该大于已经存在的实例个数) vcpus_quota 否 Integer CPU核数配额。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的cpu个数) ram_quota 否 Integer 内存使用配额,单位为GB。取值范围0~2147483646。(如果已经存在实例,应该大于已经占用的内存数)
  • 请求示例 修改指定企业项目的资源配额。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas { "quota_list" : [ { "enterprise_project_id" : "0", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 } ] }
  • 响应消息 参数说明 表2 响应Body参数 参数 参数类型 是否必选 描述 quotas Object 是 配额信息。 详情请参见表3。 表3 ShowResourcesListResponseBody 参数 参数类型 是否必选 描述 resources Objects 是 资源列表对象。 详情请参见表4。 表4 ShowResourcesDetailResponseBody 参数 参数类型 是否必选 描述 type String 是 配额资源类型,当前配额类型仅支持实例类型(instance)。 mode String 是 实例类型: 若值为“Single”,则表示单节点实例配额信息。 若值为“ReplicaSet”,则表示副本集实例配额信息。 若值为“Sharding”,则表示集群实例配额信息。 quota Integer 是 当前配额值。 used Integer 是 已使用的配额数。 响应示例 { "quotas" : { "resources" : [ { "type" : "instance", "mode" : "Sharding", "quota" : 80, "used" : 6 }, { "type" : "instance", "mode" : "ReplicaSet", "quota" : 80, "used" : 9 }, { "type" : "instance", "mode" : "Single", "quota" : 1000, "used" : 5 } ] } }
  • 响应示例 状态码: 200 OK。 { "quotas" : { "resources" : [ { "type" : "pool", "quota" : 15, "used" : 10 }, { "type" : "network", "quota" : 15, "used" : 10 } ] } }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 quotas Quota object 资源配额。 表3 Quota 参数 参数类型 描述 resources Array of ResourceQuota objects 资源的配额信息。 表4 ResourceQuota 参数 参数类型 描述 type String 资源类型。 quota String 资源配额上限。 used String 已使用配额。 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。
  • 响应示例 { "quota_set": { "cores": 20, "fixed_ips": 40, "floating_ips": 10, "id": "d9ebe43510414ef590a4aa158605329e", "injected_file_content_bytes": 10240, "injected_file_path_bytes": 255, "injected_files": 5, "instances": 20, "key_pairs": 100, "metadata_items": 128, "ram": 51200, "security_group_rules": 20, "security_groups": 50, "server_group_members": 10, "server_groups": 10 } }
  • 响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 quota_set Object quota_set对象,详情请参见表3。 表3 quota_set参数信息 参数 参数类型 描述 cores Integer vcpu数量配额 fixed_ips Integer 固定IP数量配额,目前不支持此参数 floating_ips Integer 浮动IP数量配额,目前不支持此参数 id String project的UUID injected_file_content_bytes Integer 注入文件的文件大小配额,单位字节 injected_file_path_bytes Integer 注入文件的路径大小配额,单位字节,目前不支持此参数 injected_files Integer 注入文件数量配额 instances Integer 云服务器数量配额 key_pairs Integer 密钥对数量配额,目前不支持此参数 metadata_items Integer 元数据数量配额 ram Integer 内存配额,单位MB security_group_rules Integer 每个安全组规则的配额,目前不支持此参数 security_groups Integer 安全组数量配额,目前不支持此参数 server_groups Integer 云服务器组数量配额。 server_group_members Integer 云服务器组中云服务器个数配额。
  • URI GET /v2/{project_id}/cbs/instance/ecs-quota 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法详见API参考,附录"获取项目ID" 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone 是 String 可用分区名称。 可参考接口"获取服务可用区"获取 resource_spec_code 是 String 待创建 云堡垒机 规格ID,例如: cbh.basic.10 10资产标准版 cbh.enhance.10 10资产专业版 可参考接口"查询云 堡垒机 规格信息"获取
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 status_v6 String 支持IPv6云堡垒机实例规格资源状态。 sellout:售罄 normal:正常商用 status String 云堡垒机实例规格资源状态。 sellout:售罄 normal:正常商用 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。
  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "apps" : [ { "app_id" : "ac18a23f-8f06-40ac-8093-f790de2ba95b", "app_key" : "ac18a23f-8f06-40ac-8093-f790de2ba95b", "bound_time" : "0001-01-01T00:00:00Z", "name" : "app-test", "register_time" : "2020-08-22T07:57:01Z", "status" : 1, "update_time" : "2020-08-22T07:57:01Z" } ] } 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation" } 状态码: 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码: 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码: 404 Not Found { "error_code" : "APIG.3093", "error_msg" : "The App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }