云服务器内容精选

  • 注意事项 当前只有弹性云服务器(E CS )的实例支持UniAgent的操作。 操作系统使用限制 表1 UniAgent支持的Linux操作系统及版本 操作系统 版本 EulerOS 1.1 64bit 2.0 64bit CentOS 7.1 64bit 7.2 64bit 7.3 64bit 7.4 64bit 7.5 64bit 7.6 64bit 7.7 64bit 7.8 64bit 7.9 64bit 8.0 64bit Ubuntu 16.04 server 64bit 18.04 server 64bit 20.04 server 64bit 22.04 server 64bit 对于Linux x86_64服务器,支持上表中所有的操作系统及版本。 对于Linux ARM服务器,当前CentOS操作系统支持7.4/7.5/7.6版本,EulerOS操作系统支持2.0版本,Ubuntu操作系统支持18.04版本
  • URI GET /v3/{project_id}/cas/jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 job_id 是 String 部署任务ID,为应用中创建组件、根据组件ID修改组件信息、根据组件ID下发组件任务接口响应参数的job_id。 表2 查询参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定个数。 offset 否 Integer 指定偏移量。 desc 否 String 是否降序: true=desc,false=asc。
  • 响应示例 { "job": { "execution_status": "SUCCEEDED", "job_id": "JOB17cb1778-07b1-4c8f-a183-c86cffbe8f9e", "job_type": "PROVISION" }, "tasks": [ { "task_id": "Task-af75dd60-0b04-4f4b-b669-0bad38fcdd97", "task_index": 4, "task_name": "VMAPP_CONTEXT_PREPARE_01", "task_status": "SUCCEEDED", "created_at": "2024-06-06T15:55:31.115Z", "update_at": "2024-06-06T15:55:31.136Z", "messages": "{}" }, { "task_id": "Task-50110d26-3973-49e1-95d3-d46755e865af", "task_index": 5, "task_name": "VMAPP_UPGRADE_002", "task_status": "SUCCEEDED", "created_at": "2024-06-06T15:55:31.136Z", "update_at": "2024-06-06T15:55:31.36Z", "messages": "{}" } ], "task_count": 2 }
  • 调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为 IAM 的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "region_id", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • ServiceStage错误码 在向系统发出请求后,如果遇到错误,会在响应中包含响应的错误码描述错误信息。 当您调用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 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 组件实例的版本号已被相同环境的其他实例所占用 重新提供一个新的版本号 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的仓库文件已经被修改。 父主题: 附录
  • 状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 200 - 操作成功。 304 Not Modified 未修改,所请求的资源未修改返回次状态码。 400 BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 服务器拒绝执行客户端的请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 422 UnprocessableEntity 请求格式正确,但是由于含有语义错误,无法响应。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 父主题: 附录
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:自定义策略中授权项定义的内容即为权限。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目,“√”表示支持,“×”表示暂不支持。关于IAM项目与企业项目的区别,请参考IAM与企业管理的区别。 ServiceStage的支持自定义策略授权项,请参考表1。 表1 ServiceStage授权项明细 权限 对应API接口 授权项 IAM项目 企业项目 创建应用 POST /v3/{project_id}/cas/applications servicestage:app:create √ √ 删除应用 DELETE /v3/{project_id}/cas/applications/{application_id} servicestage:app:delete √ √ 更新应用 PUT /v3/{project_id}/cas/applications/{application_id} servicestage:app:modify √ √ 查看应用列表 GET /v3/{project_id}/cas/applications servicestage:app:list √ √ 查询应用信息 GET /v3/{project_id}/cas/applications/{application_id} servicestage:app:get √ √ 修改工程 - servicestage:project:modify √ √ 创建工程 - servicestage:project:create √ √ 审批应用 - servicestage:app:approve √ √ 查看流水线列表 - servicestage:pipeline:list √ √ 修改构建 - servicestage:assembling:modify √ √ 审批流水线 - servicestage:pipeline:review √ √ 执行流水线 - servicestage:pipeline:execute √ √ 查看构建信息 - servicestage:project:get √ √ 删除构建 - servicestage:assembling:delete √ √ 删除流水线 - servicestage:pipeline:delete √ √ 删除工程 - servicestage:project:delete √ √ 修改流水线 - servicestage:pipeline:modify √ √ 创建构建 - servicestage:assembling:create √ √ 查看构建列表 - servicestage:assembling:list √ √ 查看构建信息 - servicestage:assembling:get √ √ 查看工程列表 - servicestage:project:list √ √ 查看流水线信息 - servicestage:pipeline:get √ √ 创建流水线 - servicestage:pipeline:create √ √
  • 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 微服务扩展属性请求结构体。 父主题: 公共响应参数
  • 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 总超时个数。 父主题: 公共响应参数
  • 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 时间戳。 父主题: 公共响应参数
  • WatchMicroServiceKey 表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不支持*。 version 否 String 微服务版本。作为provider支持+、固定版本和latest(当前最新版本),如1.0.1+,表示1.0.1以上的版本,包括1.0.1。作为consumer只能为固定版本。 父主题: 公共响应参数
  • DataCenterInfo 表1 参数说明 参数 是否必选 参数类型 描述 name 是 String 数据中心名称,支持数字、字母,支持使用字符_-.做连接符,长度1-128字节。 region 是 String 数据中心所属区 域名 称,支持数字、字母,支持使用字符_-.做连接符,长度1-128字节。 availableZone 是 String 数据中心所属可用区名称,支持数字、字母,支持使用字符_-.做连接符,长度1-128字节。 父主题: 公共请求参数
  • 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 父主题: 公共请求参数