云服务器内容精选

  • 响应消息 正常响应要素说明 表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 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 具体错误信息。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 is_enough Boolean 配额是否足够true:足够 false:不足。 quota_remainder Array of QuotaRemainderData objects 配额剩余数量信息。 表5 QuotaRemainderData 参数 参数类型 描述 type String 配额-资源类型: GPU_INSTAN CES :GPU资源实例数,单位个。 INSTANCES:普通实例数,单位个。 VOLUME_GIGABYTES:磁盘总容量,单位GB。 VOLUMES:磁盘数量,单位个。 CORES:CPU数量,单位个。 MEMORY:内存容量,单位MB。 remainder Integer 剩余配额。 need Integer 所需配额。 状态码:400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 响应示例 状态码:200 校验本次订单提交资源是否足额响应类。 { "is_enough" : true, "quota_remainder" : [ { "type" : "INSTANCES", "remainder" : 490, "need" : 1 }, { "type" : "VOLUME_GIGABYTES", "remainder" : 69360, "need" : 60 }, { "type" : "VOLUMES", "remainder" : 9990, "need" : 1 }, { "type" : "CORES", "remainder" : 39980, "need" : 2 }, { "type" : "MEMORY", "remainder" : 99959040, "need" : 4096 } ] }
  • URI GET /v1/{project_id}/check/quota 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目唯一标识。 表2 Query参数 参数 是否必选 参数类型 描述 product_id 是 String 产品id。 flavor_id 否 String 规格id。 subscription_num 是 Integer 订单需要创建总实例数、订购数量。 disk_size 是 Integer 单台实例所需的磁盘大小(最大系统盘1块1024、数据盘10块32768)。 disk_num 是 Integer 单台实例所需的磁盘数量(最大系统盘1块、数据盘10块)。 is_period 否 Boolean 是否包周期。 deh_id 否 String 主机id。 cluster_id 否 String 云专属分布式存储池id。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 quotas ShowResourcesListResponseBody object 参数解释: 配额信息。 表5 ShowResourcesListResponseBody 参数 参数类型 描述 resources Array of ShowResourcesDetailResponseBody objects 参数解释: 资源列表对象。 表6 ShowResourcesDetailResponseBody 参数 参数类型 描述 type String 参数解释: 配额资源类型。 约束限制: 当前配额类型仅支持实例类型(instance)。 取值范围: 不涉及。 quota Integer 参数解释: 当前配额值。 取值为0时,表示不限制当前配额值。 取值范围: 不涉及。 used Integer 参数解释: 已使用的资源数。 取值范围: 不涉及。
  • URI GET https://{Endpoint}/v3/{project_id}/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 datastore_type 否 String 参数解释: 数据库类型。 约束限制: 不涉及。 取值范围: 取值为“cassandra”,表示查询GeminiDB Cassandra数据库实例配额。 取值为“mongodb”,表示GeminiDB Mongo查询数据库实例配额。 取值为“influxdb”,表示查询GeminiDB Influx数据库实例配额。 取值为“redis”,表示查询GeminiDB Redis数据库实例配额。 默认取值: 如果不传该参数,表示查询所有数据库实例配额。 mode 否 String 参数解释: 实例类型。 约束限制: 不涉及。 取值范围: 取值为“Cluster”,表示GeminiDB Redis Proxy集群,GeminiDB Cassandra、GeminiDB Influx经典部署模式集群实例类型。 取值为“CloudNativeCluster”,表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。 取值为“RedisCluster”,表示GeminiDB Redis Cluster经典部署模式集群实例类型。 取值为“Replication”,表示GeminiDB Redis经典部署模式主备实例类型。 取值为“InfluxdbSingle”,表示GeminiDB Influx经典部署模式单节点实例类型。 取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。 默认取值: 如果不传datastore_type参数,自动忽略该参数设置,传入datastore_type时,该参数必填。 product_type 否 String 参数解释: 产品类型。 约束限制: 不涉及。 取值范围: Capacity 容量型 Standard 标准型 当查询GeminiDB redis云原生部署模式集群类型配额必传此参数。 默认取值: 不涉及。
  • 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资源。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 X-Language 否 String 语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 X-Time-Zone 否 String 环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32
  • 响应示例 状态码: 200 OK { "app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3", "call_limits" : 1000, "create_time" : "2020-09-19T07:27:47Z", "name" : "ClientQuota_demo", "reset_time" : "2020-09-20 00:00:00 +0000 +0000", "time_interval" : 1, "time_unit" : "DAY"} 状态码: 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" : "App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist"} 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 app_quota_id String 凭据配额编号 name String 配额名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3-255字符 call_limits Integer 凭据配额的访问次数限制 time_unit String 限定时间单位:SECOND:秒、MINUTE:分、HOUR:时、DAY:天 time_interval Integer 配额的限定时间值 remark String 参数说明和描述 最大长度:255 reset_time String 首次配额重置时间点,不配置默认为首次调用时间计算 create_time String 创建时间 bound_app_num Integer 配额策略已绑定应用数量 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_quota_id 是 String 凭据配额编号
  • 响应消息 响应参数如表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 云服务器组中云服务器个数配额。