云服务器内容精选

  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 请求示例 修改指定service_id和schema_id的契约的契约内容和摘要。 PUT https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id} { "schema": "---\nswagger: \"2.0\"\ninfo:\n version: \"1.0.0\"\n title: \"swagger definition for com.service.provider.controller.ProviderImpl\"\n x-java-interface: \"cse.gen.springmvc.provider.provider.ProviderImplIntf\"\nbasePath: \"/provider\"\nconsumes:\n- \"application/json\"\nproduces:\n- \"application/json\"\npaths:\n /helloworld:\n get:\n operationId: \"helloworld\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"query\"\n required: true\n type: \"string\"\n responses:\n 200:\n description: \"response of 200\"\n schema:\n type: \"string\"\n", "summary": "test" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 schema 是 String 契约内容。 summary 否 String 新加入参数,后面创建schema,请尽量提供schema的摘要。
  • URI PUT /v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 service_id 是 String 微服务唯一标识。字符长度为1~64,正则表达式为^.*$。获取方法请参考查询所有微服务信息。 schema_id 是 String 微服务契约唯一标识。字符长度为1~160,正则表达式为^[a-zA-Z0-9]{1,160}$|^[a-zA-Z0-9][a-zA-Z0-9_-.]{0,158}[a-zA-Z0-9]$。获取方法请参考查询微服务的所有契约。
  • 响应消息 表5 响应参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 description String 应用描述。 creator String 应用创建人。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 create_time Integer 应用创建时间。 update_time Integer 应用修改时间。 component_count Integer 应用下部署的组件个数。 labels Array of objects 标签,可使用标签管理服务通过标签过滤资源,请参考表6。 表6 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。
  • 请求示例 修改应用名称为app-xpmtii2,描述信息修改为test2,标签键值对修改为"key":"var"。 { "name": "app-xpmtii2", "description": "test2", "labels": [ { "key": "key", "value": "var" } ] }
  • 响应示例 { "id": "dae29983-c1e9-437d-a6be-5256076fe605", "name": "app-xpmtii2", "description": "test2", "project_id": "063a3158b1a34710b36ad208b9497d00", "creator": "ss-test", "create_time": 1679468852302, "update_time": 1679470928765, "component_count": 0, "labels": [ { "key": "key", "value": "var" } ] }
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 应用名称。 由英文字母、数字、中划线(-)或下划线(_)组成,并以英文字母开头,英文字母或者数字结尾,长度为2~64个字符。 description 否 String 应用描述。 最大长度为128个字符。 enterprise_project_id 否 String 企业项目ID。 labels 否 Array of objects 标签,可使用标签管理服务通过标签过滤资源,请参考表4。 同一个应用下最多可以添加20个标签。 表4 labels 参数 是否必选 参数类型 描述 key 是 String 标签名称。 标签用于标识资源,当您拥有相同类型的许多资源时,可以使用标签按各种维度(例如用途、所有者或环境)对资源进行分类。 长度为1到36个字符,只能包含数字、英文字母、下划线(_)、中划线(-)或中文。 value 是 String 标签值。 长度为2到43个字符,只能包含数字、英文字母、下划线(_)、点(.)、中划线(-)或中文。
  • 请求示例 修改环境E CS 资源为id为67835bb3-1235-4cc9-be71-becbb2b4ca0d、名称为ecs-a5a9的弹性云服务器。 { "resources": [ { "id": "67835bb3-1235-4cc9-be71-becbb2b4ca0d", "name": "ecs-a5a9", "type": "ecs" } ] }
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of objects 添加资源,请参考表4。 表4 resources 参数 是否必选 参数类型 描述 id 是 String 资源ID(为了保证接口调用正常,请您确保调用前输入正确的资源ID)。 name 否 String 资源名称。 type 是 String 资源类型。 eip,弹性公网IP。 elb,弹性负载均衡。 cce,云容器引擎。 ecs,弹性云服务器。 as,弹性伸缩组。 cse,微服务引擎。 dcs,分布式缓存服务。 rds,云数据库。
  • 响应消息 表5 响应参数 参数 参数类型 描述 resources Array of objects 资源,请参考表6。 表6 schemas 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 资源类型。 eip,弹性公网IP。 elb,弹性负载均衡。 cce,云容器引擎。 ecs,弹性云服务器。 as,弹性伸缩组。 cse,微服务引擎。 dcs,分布式缓存服务。 rds,云数据库。
  • 响应消息 表5 响应参数 参数 参数类型 描述 id String 应用ID。 name String 应用名称。 description String 应用描述。 creator String 应用创建人。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 create_time Integer 应用创建时间。 update_time Integer 应用修改时间。 labels Array of objects 标签,可使用标签管理服务通过标签过滤资源,请参考表6。 表6 labels 参数 参数类型 描述 key String 标签名称。 value String 标签值。
  • 请求示例 创建名称为app-xpmtii的应用,描述信息输入test,标签键值对设置为"key":"var"。 { "name": "app-xpmtii", "description": "test", "labels": [ { "key": "key", "value": "var" } ] }
  • 请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 应用名称。 由英文字母、数字、中划线(-)或下划线(_)组成,并以英文字母开头,英文字母或者数字结尾,长度为2~64个字符。 description 否 String 应用描述。 最大长度为128个字符。 enterprise_project_id 否 String 企业项目ID。 labels 否 Array of objects 标签,可使用标签管理服务通过标签过滤资源,请参考表4。 同一个应用下最多可以添加20个标签。 表4 labels 参数 是否必选 参数类型 描述 key 是 String 标签名称。 标签用于标识资源,当您拥有相同类型的许多资源时,可以使用标签按各种维度(例如用途、所有者或环境)对资源进行分类。 长度为1到36个字符,只能包含数字、英文字母、下划线(_)、中划线(-)或中文。 value 是 String 标签值。 长度为2到43个字符,只能包含数字、英文字母、下划线(_)、点(.)、中划线(-)或中文。
  • 响应示例 { "id": "dae29983-c1e9-437d-a6be-5256076fe605", "name": "app-xpmtii", "description": "test", "project_id": "063a3158b1a34710b36ad208b9497d00", "enterprise_project_id": "0", "creator": "ss-test", "create_time": 1679468852302, "update_time": 1679468852302, "labels": [ { "key": "key", "value": "var" } ] }