华为云用户手册

  • 请求示例 修改环境资源,添加名称为ecs-9876的ECS基础资源、专业版CSE可选资源,移除名称为test的CCE资源。 {"add_base_resources": [{"id": "ed2f3420-7031-4d93-b92b-e360cd4acf9e","type": "ecs","name": "ecs-9876"}],"add_optional_resources": [{"id": "default","type": "cse","name": "Cloud Service Engine"}],"remove_resources": [{"id": "523498f1-36c4-11eb-ae36-0255ac1000c2","name": "test","type": "cce"}]}
  • 响应消息 表6 参数说明 参数 参数类型 描述 id String 环境ID name String 环境名称 alias String 环境别名 description String 环境描述 project_id String 项目ID enterprise_project_id String 企业项目ID charge_mode String 收费模式 vpc_id String 虚拟私有云ID base_resources Array of objects 基础资源。请参考表7 optional_resources Array of objects 可选资源。请参考表7 creator String 创建人 create_time Integer 创建时间 update_time Integer 修改时间 表7 schemas参数 参数 参数类型 描述 id String 资源ID name String 资源名称 type String 基础资源:cce、cci、ecs、as 可选资源:rds、dcs、elb等其他类型
  • 响应消息 表3 响应参数 参数 参数类型 描述 id String 应用ID name String 应用名称 description String 应用描述 creator String 创建人 project_id String 项目ID enterprise_project_id String 企业项目ID create_time Integer 创建时间 update_time Integer 修改时间 unified_model String 是否统一模型
  • 响应示例 {"id": "e5213b62-0e3c-476f-9960-3e4108787350","name": "app-xpmtii","description": "test","project_id": "e7d2e9c589e5445e808a8ff0d1235aca","enterprise_project_id": "0","creator": "ss-test","create_time": 1610432385245,"update_time": 1610432385245,"unified_model": null}
  • 响应示例 { "url": "https://github.com/login/oauth/authorize?client_id=2993bccf255673ba****&redirect_uri=https%3A%2F%2Fconsole.****.com%2Fservicestage%2Foauth%3Frepo_type%3Dgithub&state=%242a%2410%24%2FMOymg0euuGH%2FJNWIJI3FeSVZhTUVj%2FF7r52mqpUKcYXz7f6.****&scope=read%3Auser%20repo%20write%3Arepo_hook"}
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xx-xxxxxx-1", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_code": "FGS.0111", "error_msg": "xxxxxxxxx"} 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 响应示例 { "authorizations": [ { "name": "test", "repo_type": "github", "repo_host": "https://api.github.com", "repo_home": "https://github.com/tom-repo", "repo_user": "tom-repo", "avartar": "https://avatars.githubusercontent.com/u/73919200?v=4", "token_type": "oauth", "create_time": 1649731565642, "update_time": 1649731565642, "tag": null, "status": 0 } ], "count": 1 }
  • URI GET /v1/{project_id}/git/auths/{repo_type}/redirect 参数说明见表1。 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 repo_type 是 String 仓库类型。 取值范围:devcloud、github、gitlab、gitee、bitbucket。 表2 查询参数 参数 是否必选 类型 描述 tag 否 String 站点标签。
  • 错误码 在向系统发出请求后,如果遇到错误,会在响应中包含响应的错误码描述错误信息。 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 错误码如下所示。 状态码 错误码 错误信息 描述 处理措施 400 SVCSTG.00100400 parameter invalid 错误请求 检查参数是否正确,稍后重试 400 SVCSTG.00100402 component was deployed, uninstall first 组件已部署,请先卸载 卸载组件后重试 400 SVCSTG.00100414 job id can not empty job id不能为空 请指定job id进行查询 400 SVCSTG.00100418 component instance action not defined 未定义组件实例操作 请指定合法的组件实例操作 400 SVCSTG.00100420 runtime not supported 不支持运行时 请指定支持的运行时 400 SVCSTG.00100422 base resource can not empty 基础资源不能为空 请设置基础资源 400 SVCSTG.00100425 instance artifacts can not be empty 实例的软件包或者镜像为空 报文中的artifact参数不能为空 400 SVCSTG.00100449 environment name is already used 环境名已被占用 重新提供一个新的环境名 400 SVCSTG.REPO.0400 parameter invalid 错误请求 检查参数是否正确,稍后重试 400 SVCSTG.REPO.0401 repository not implemented 错误请求 请选择其他仓库类型 400 SVCSTG.REPO.0402 oauth code or state invalid 错误请求 请重新进行OAuth2授权,获取正确的认证码和随机串 400 SVCSTG.REPO.0403 resource already exist 错误请求 调用查询接口,检查是否存在重复的资源 400 SVCSTG.REPO.0450 no repository authorization 错误请求 检查请求header是否输入正确授权名称 400 SVCSTG.REPO.0451 repository authorization invalid 错误请求 重新授权 400 SVCSTG.REPO.0452 clone url invalid 错误请求 检查查询参数clone_url是否正确. 示例:https://user-name@github.com/user-name/demo.git 400 SVCSTG.00501134 The engine type is left blank. 引擎类型不合法 引擎类型字段为请求query的specType字段,将其设置为一个合法值(比如CSE)后重试请求。例如,当查询微服务引擎专享版支持规格时将specType设置为CSE 400 SVCSTG.00500400 Internal service request parameter error. 服务内部请求参数错误 检查报错error_message内容,如参数不合法,则检查输入参数是否正确;其他错误可联系技术支持工程师协助解决 400 SVCSTG.00501111 Duplicate engine instance name. 引擎实例名称重复 更换引擎名称 400 SVCSTG.00501112 Insufficient engine instance quota. 引擎实例配额不足 联系技术支持工程师扩大对应引擎实例配额,或者删除不用的引擎实例 400 SVCSTG.00501133 The number of engines has reached the upper limit of the site. 引擎数量达到局点上限 联系技术支持工程师处理 400 SVCSTG.00501104 Incorrect format of the engine instance specifications. 引擎实例的规格格式错误 规格无效,请填写符合要求的规格 400 SVCSTG.00501105 Incorrect AZ format. 可用区格式错误 请求参数中指定合法有效的可用区,可用区字段的类型为字符串数组,不能为空,且可用区名称层级数量范围是1-3 400 SVCSTG.00501117 The engine in the current state cannot be deleted. 无法删除此状态的引擎 等待引擎状态变为可用、不可用、创建失败等状态时再重试 400 SVCSTG.00501152 Incorrect task ID format. 任务ID格式错误 传入创建引擎,删除引擎等接口返回的job_id 400 SVCSTG.00501153 No task found. 找不到任务 传入创建引擎,删除引擎等接口返回的job_id 400 SVCSTG.00501149 This engine has abnormal nodes 引擎节点状态异常 请稍后重试或联系技术支持工程师。 400 SVCSTG.00501201 The peer engine name must start with a letter, composed of letters, numbers, and cannot end with -. The valid length is 3-24 characters. And the name cannot be "default", cannot equal with engine name. 同步引擎实例名称格式错误 对等引擎实例名称须为字母开头,字母、数字、-组成且不能以-结尾,3-24个字符,不能命名为default,同时不能与当前引擎实例名称相同 400 SVCSTG.00501202 The peer engine name must start with a letter, composed of letters, numbers, and cannot end with -. The valid length is 3-24 characters. And the name cannot be "default", cannot equal with engine name. 同步引擎规格无效 同步引擎的规格必须是高可用引擎,请重新传入引擎规格 400 SVCSTG.00501203 The peer engine must be in a single AZ. 同步引擎可用区无效 同步引擎的可用区必须为单可用区,请重新传入可用区列表 400 400001 Invalid parameter(s) 非法参数 根据错误提示中的规则,修改提示中的参数 400 400010 Micro-service already exists 服务已存在 修改创建微服务body体中的serviceId或微服务描述信息 400 400012 Micro-service does not exist 服务不存在 请输入有效的serviceId 400 400013 Micro-service has deployed instance(s) 无法删除该微服务,该微服务已部署实例 请先将实例下线,再删除微服务;或强制删除微服务(url中添加query参数“force=true”) 400 400014 Undefined schema id schemaId不存在 请输入有效的schemaId 400 400015 Not allowed to modify schema schema不允许修改 该schema已注册,不支持修改 400 400016 Schema does not exist schema不存在 请先注册schema再查询 400 400017 Instance does not exist 实例不存在 请输入有效的instanceId 400 400023 Cosumer(s) depends on this micro-service 无法删除该微服务,该微服务被其他微服务依赖 可选择强制删除微服务(url中添加query参数“force=true”) 400 400026 Micro-service version does not exist 微服务版本不存在 请输入正确的版本号或版本号范围 400 400100 Not enough quota 配额不足 对应的资源(如微服务、实例、schema)配额不足,请删除部分资源再创建 401 SVCSTG.00300401 Invalid token 认证不通过 输入正确的token 401 401002 Request unauthorized 认证不通过 输入正确的token 401 401204 No authorization header 认证不通过 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer{Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 401 401201 Request unauthorized 认证不通过 输入的Authorization不合法 401 401202 User name or password is wrong 帐号名称或密码错误 输入正确的帐号名称和密码 403 403001 ErrForbidden 操作受限 使用合理的帐号进行操作 404 SVCSTG.00100403 application not found 应用未找到 请指定已经存在的应用 404 SVCSTG.00100404 component not found 组件未找到 请指定已经存在的组件 404 SVCSTG.00100408 request not found 请求未找到 请指定已经存在的请求 404 SVCSTG.00100411 environment not found 环境未找到 请指定存在的环境 404 SVCSTG.00100412 instance not found 实例未找到 请对存在的实例进行操作 404 SVCSTG.00100424 elb instance not found elb实例未找到 请指定已经存在的elb实例 404 SVCSTG.00100429 job not found 构建工程未找到 请指定已经存在的构建工程 404 SVCSTG.00100433 application release not found 发布任务未找到 请选择已经存在的发布任务 404 SVCSTG.00100436 snapshot not found 实例快照未找到 请指定已经存在的实例快照 404 SVCSTG.00100438 template image not found 模板镜像未找到 请指定已经存在的模板镜像 404 SVCSTG.00100441 instance version is already used by other instances in the same environment 组件实例的版本号已被相同环境的其他实例所占用 重新提供一个新的版本号 404 SVCSTG.00501116 Failed to find the engine instance. 找不到引擎实例 无需特别处理,只需要检查传入的引擎ID是否正确。可以使用租户的用户名密码登录到ServiceStage页面,查看当前租户下面是否有对应引擎ID的引擎 405 SVCSTG.00100421 account is limit suspended 帐户已被暂停限额 恢复帐号至正常状态 405 SVCSTG.00100427 permission denied 没有权限 重新授权 408 SVCSTG.00100428 request timeout 系统处理超时 系统繁忙,请稍后再试 409 SVCSTG.00100401 application not empty 应用不为空 删除应用下的组件再删除应用 409 SVCSTG.00100413 instance name exists 实例名已经存在 更换实例名 409 SVCSTG.00100419 can not operate in current status 当前状态不能操作 当前操作未完成,请稍后再试 409 SVCSTG.00100423 component instance is not deletable 组件实例当前状态不可删除 当前操作未完成,请稍后再试 409 SVCSTG.00100426 environment is in use 环境已经被使用 删除部署在环境上的实例后再删除环境 409 SVCSTG.00100432 component in releasing 组件当前已在发布任务中 请等待当前发布任务执行结束后再重试 409 SVCSTG.00100435 release can not delete 发布任务当前状态不能删除 当前操作未完成,请稍后再试 409 SVCSTG.00100439 elb is already used in other instance of component elb实例已经在组件中被使用 请使用其他elb实例重试 500 SVCSTG.00100500 service internal error 服务内部错误 系统繁忙,请稍后重试 500 SVCSTG.00100501 remote service error 远程服务错误 系统繁忙,请稍后重试 500 SVCSTG.REPO.0500 service internal error 服务内部错误 网络异常等原因,稍后重试。 500 SVCSTG.REPO.0501 remote repository error 服务内部错误 检查请求参数是否正确,或者远端GIT的仓库文件已经被修改。 500 SVCSTG.00300605 Failed to connect the configuration center to ETCD. 服务内部错误 内部错误请联系运维支持。 500 SVCSTG.00300500 Internal server error 服务内部错误 内部错误请联系运维支持。 500 500003 Internal server error 内部错误 内部错误请联系运维支持。 500 500011 Registry service is unavailable 后端错误 内部错误请联系运维支持。 父主题: 附录
  • ServiceDetail 表1 参数说明 参数 是否必选 类型 描述 microService 否 MicroService 服务信息 instances 否 MicroServiceInstance 实例信息 schemaInfos 否 Schema 微服务的API详细信息 rules 否 Rule 黑白名单信息 providers 否 MicroService 所有的provider信息 consumers 否 MicroService 所有的consumer信息 tags 否 Tags 微服务所有的标签信息 microServiceVersions 否 Array,每一项为String 微服务的所有版本信息 表2 Tags参数说明 参数 是否必选 类型 描述 tags 否 Properties 微服务扩展属性请求结构体 父主题: 公共响应参数
  • URI GET /v4/{project_id}/registry/microservices/{serviceId}/schemas/{schemaId} 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 serviceId 是 String 微服务唯一标识,字符长度为1~64,正则表达式为^.*$。 获取方法,请参考查询所有微服务静态信息。 schemaId 是 String 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"}
  • 响应示例 {"schemas": [{"schemaId": "xxxxmvc","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\"\nxxxx","summary": "abcda7b4072ef2d7a5fc9aefccf03e5548029ae31c6cd5fc29da7685d6d9e14adea3"}]}
  • URI GET /v4/{project_id}/registry/microservices/{serviceId}/schemas 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 serviceId 是 String 微服务唯一标识,字符长度为1~64,正则表达式为^.*$。 获取方法,请参考查询所有微服务静态信息。 表2 Query参数 参数 是否必选 类型 描述 withSchema 否 String 是否查询schema内容,默认为0。 0表示不显示schema内容,只有schemaId和summary。 1表示显示schemaId、summary和schema。
  • AggregateMetricInfo 表1 参数说明 参数 是否必选 类型 描述 time 否 Integer 上报时间。 name 否 String 接口名称。 qps 否 Number 当前qps。 latency 否 Number 平均时延。 rate 否 Integer 成功率。 total 否 Integer 总请求数。 isCircuitBreakerOpen 否 Boolean 断路器是否打开。 failure 否 Integer 总失败数。 shortCircuited 否 Integer 总短路个数。 semaphoreRejected 否 Integer 总信号量拒绝个数。 threadPoolRejected 否 Integer 总线程拒绝个数。 countTimeout 否 Integer 总超时个数。 父主题: 公共响应参数
  • MetricData 表1 参数说明 参数 是否必选 类型 描述 name 是 String 服务名称。 appId 是 String 应用Id。 serviceId 否 String 服务Id。 version 是 String 服务版本号。 instanceId 否 String 实例Id。 instance 是 String 实例名称。 thread 否 String 线程数。 cpu 否 String CPU使用率。 memory 否 String 内存。 interfaces 否 表2 实例包含的详细接口数据。 serviceId和instanceId两个参数必须同时存在或者同时不存在。 表2 items参数说明 参数 是否必选 类型 描述 items 否 FunctionMetricInfo 接口级别聚合指标数据。 父主题: 参数说明
  • FunctionMetricInfo 表1 参数说明 参数 是否必选 类型 描述 AggregateMetricInfo 否 Object 聚合指标数据。 l995 否 Integer 99.5%的请求低于此值。 l99 否 Integer 99%的请求低于此值。 l90 否 Integer 90%的请求低于此值。 l75 否 Integer 75%的请求低于此值。 l50 否 Integer 50%的请求低于此值。 l25 否 Integer 25%的请求低于此值。 l5 否 Integer 5%的请求低于此值。 父主题: 参数说明
  • ServiceInfo 表1 参数说明 参数 是否必选 类型 描述 serviceId 是 String 微服务唯一标识。字符为uuid。 正则表达式为^.*$ appId 是 String 应用app唯一标识。 字符长度为1~160。 正则表达式为^[a-zA-Z0-9]*$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]*[a-zA-Z0-9]$ serviceName 是 String 微服务名称,同一个App要保证唯一。 字符长度为1~128。 正则表达式为^[a-zA-Z0-9]*$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]*[a-zA-Z0-9]$ version 是 String 微服务版本号。 字符长度为1~64。 正则表达式为^[0-9]*$|^[0-9]+(\.[0-9]+)*$' level 是 String 微服务层级。包括: FRONT MIDDLE BACK status 是 String 服务状态。 UP DOWN timestamp 是 String 时间戳。 父主题: 公共响应参数
  • HealthCheck 表1 参数说明 参数 是否必选 类型 描述 mode 是 String check模式,push/pull。 port 否 Integer 端口。 字符长度不超过65536。 正则表达式为^[0-9]*$ interval 是 Integer 心跳间隔(秒),当值小于5秒时,按5秒注册。 字符长度不超过4294967296。 正则表达式为^[0-9]+$ times 是 Integer 最大尝试请求次数。 字符长度不超过4294967296。 正则表达式为^[0-9]+$ 父主题: 参数说明
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。
  • 请求示例 POST https://{endpoint}/v2/{project_id}/csemonitor/metric{ "name" : "test", "appId" : "default", "version" : "1.0.0", "instance" : "hostNameTest", "thread" : 0, "cpu" : 0, "memory" : { "1":"1" }, "interfaces" : [ { "time" : 0, "name" : "test", "qps" : 0, "latency" : 0, "rate" : 0, "total" : 0, "isCircuitBreakerOpen" : true, "failure" : 0, "shortCircuited" : 0, "semaphoreRejected" : 0, "threadPoolRejected" : 0, "countTimeout" : 0, "l995" : 0, "l99" : 0, "l90" : 0, "l75" : 0, "l50" : 0, "l25" : 0, "l5" : 0 } ]}
  • DataCenterInfo 表1 参数说明 参数 是否必选 类型 描述 name 是 String 数据中心名称,支持数字、字母,支持使用字符_-.做连接符,长度1-128字节。 region 是 String 数据中心所属区域名称,支持数字、字母,支持使用字符_-.做连接符,长度1-128字节。 availableZone 是 String 数据中心所属可用区名称,支持数字、字母,支持使用字符_-.做连接符,长度1-128字节。 父主题: 公共请求参数
  • URI GET /v1/{project_id}/git/files/{namespace}/{project}/trees 参数说明见表1。 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。 表2 查询参数 参数 是否必选 类型 描述 ref 是 String 分支名称或者tag名称或者commit sha。
  • AddOrUpdateRule 表1 参数说明 参数 是否必选 类型 描述 ruleType 否 String 类型,WHITE表示白名单、BLACK表示黑名单。 attribute 否 String 如果是tag_xxx开头,则按Tag过滤attribute属性。否则,则按ServiceId、AppId、ServiceName、Version、Description、Level、Status过滤。 pattern 否 String 匹配规则,正则表达式,长度1到64个字符。 description 否 String rule的描述。 字符长度不超过256个字符。 父主题: 公共请求参数
  • Rule 表1 参数说明 参数 是否必选 类型 描述 ruleId 否 String 黑白名单ID ruleType 是 String 类型,WHITE表示白名单、BLACK表示黑名单 attribute 是 String 如果是tag_xxx开头,则按Tag过滤attribute属性。否则,则按ServiceId、AppId、ServiceName、Version、Description、Level、Status过滤。 pattern 是 String 匹配规则,正则表达式,长度1到64个字符。 timestamp 否 String 创建rule的时间,只有获取rule时返回使用。 description 否 String Rule的描述信息,字符长度不超过256。 modTimestamp 否 String 最后修改UTC时间 父主题: 公共请求参数
  • DependencyMicroService 表1 参数说明 参数 是否必选 类型 描述 appId 是 String 应用app唯一标识。 字符长度为1~160。 正则表达式为^[a-zA-Z0-9]*$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]*[a-zA-Z0-9]$ serviceName 是 String 微服务名称。 作为provider支持为*,表示依赖同一租户下的所有服务。当服务名称为*时,appId和version可以省略。 consumer不支持*。 字符长度为1~128。 正则表达式为^[a-zA-Z0-9]*$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]*[a-zA-Z0-9]$ version 是 String 版本规则,若为微服务引擎专业版,此参数必填;否则,无此参数。 表示精确版本匹配,如:0.0.1 表示后续版本匹配,如:0.0.1+ 表示最新版本,如:latest 表示版本范围,如:0.1.0-0.2.0 environment 是 String 微服务的环境信息。包括: 空 development testing acceptance production 父主题: 公共请求参数
  • 请求消息 表3 请求Header参数 参数 是否必选 类型 描述 x-environment 否 String 指定查询配置的environment,取值包括:development、testing、acceptance、production。其他值均被作为空值处理。 Authorization 是 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。
  • URI GET /v3/{project_id}/configuration/items 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 表2 Query参数 参数 是否必选 类型 描述 dimensionsInfo 是 String 服务信息,为服务名、应用、版本的拼接(服务名、应用必填,版本选填),拼接格式为(请注意“@”和“#”添加到http url时需转义,“@”转义为“%40”,“#”转义为“%23”): {serviceName}@{appId}#{version} 或{serviceName}@{appId} 不能包含$%^&+/\特殊字符和空格。 keyFilter 否 String key的筛选条件, 支持正则表达式。涉及特殊字符的正则表达式需要自行转义。 revision 否 String 配置项版本。用于判断本地缓存配置和配置管理中心的配置差异。 首次传值0。 若传入的revision值与当前配置的revision一致,则返回304状态码,无body体返回;若不一致,则返回当前配置和revision信息。 下次请求若需要传入revision,则该值为当前返回body体中的revision中的version的值 。
  • 请求示例 修改serviceId为a0c572b9ede946712698081a87552a7a87169bcb的微服务下的instanceId为831113358b7811ebb23100ff14de2ec3的微服务实例的状态为UP,即在线。 PUT /v4/default/registry/microservices/a0c572b9ede946712698081a87552a7a87169bcb/instances/831113358b7811ebb23100ff14de2ec3/status?value=UP
  • URI PUT /v4/{project_id}/registry/microservices/{serviceId}/instances/{instanceId}/status 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 serviceId 是 String 微服务唯一标识,字符长度为1~64位,正则表达式为^.*$。 获取方法,请参考查询所有微服务静态信息。 instanceId 是 String 微服务实例唯一标识,字符长度为1~64位,正则表达式为^[A-Za-z0-9_.-]*$。 获取方法,请参考根据serviceId查询微服务实例。 表2 Query参数 参数 是否必选 类型 描述 value 是 String 实例状态。 UP,表示在线。 OUTOFSERVICE,表示摘机。 STARTING,表示正在启动。 DOWN,表示下线。 TESTING,表示拨测。
共100000条