华为云用户手册

  • 使用方式 表1 删除碎片的不同方式 工具 方法 OBS控制台 OBS控制台提供图形化的碎片列表界面,您可以一键批量删除桶中所选中的碎片。 具体操作请参见清理碎片。 OBS Browser+ 您可以一键批量删除桶中所选中的碎片。也可以单击页面上方“删除所有”,清除所有碎片。 obsutil obsutil分段上传任务产生的碎片,可以通过删除分段上传任务来删除碎片。如果一个桶内有多个分段任务,则需要删除多个任务来删除桶中所有碎片。 具体操作请参见删除分段上传任务。 OBS API 您可以通过以下步骤来直接删除桶中碎片: 使用列举桶中已初始化多段任务接口,来列举所有分段上传任务,获取所有UploadId。 使用取消多段上传任务接口,来取消分段上传任务,即可删除所有碎片。 OBS SDK OBS SDK通常只有采用多段上传,并且最后没有合并多段上传任务时会产生碎片,您通过取消多段上传任务来删除桶内碎片。步骤如下: 使用ObsClient.listMultipartUploads列举所有分段上传任务,获取所有UploadId。 使用ObsClient.abortMultipartUpload取消分段上传任务,即可删除所有分段碎片。
  • 手动删除和自动删除 您可以随时手动删除对象,也可以通过生命周期管理功能,定期自动删除桶中对象或者一次性清空桶中所有对象。 对于并行文件系统目录,大数据场景下(目录层级深、目录下文件多)的删除,可能会因超时而删除失败,建议使用: hadoop 客户端(嵌套OBS客户端插件OBSA)删除目录:hadoop fs - rmr obs://{并行文件系统名}/{目录名}。 给目录配置生命周期规则,通过生命周期后台删除。
  • 背景知识 跨域是指不同域名之间相互访问。 跨域访问是浏览器出于安全考虑而设置的一个限制,即同源策略。由于JavaScript同源策略的限制,A域名下的JavaScript无法操作B域名或C域名下的对象。 同协议、同域名(或IP)、以及同端口视为同一个域。两个页面的协议、域名和端口(若指定了端口)相同,则视为同源。为了更好的理解是否同源,您可以查看表1中相对https://support.huaweicloud.com/dir/test.html的同源检测示例。 表1 同源检测示例 URL 访问结果 原因 https://support.huaweicloud.com/dir/other.html 成功 协议、域名、端口都相同 https://support.huaweicloud.com/dir/inner/other.html 成功 协议、域名、端口都相同 http://support.huaweicloud.com/dir/test.html 失败 域名、端口相同,协议不同 https://support.huaweicloud.com:81/dir/test.html 失败 协议、域名相同,端口不同 https://help.huaweicloud.com/dir/test.html 失败 协议、端口相同,域名不同
  • 使用场景 通常您的业务系统可能使用了华为云的多种云服务,您可以为这些云服务下不同的资源实例分别设置标签(对于OBS而言,资源实例即为桶),各服务产生的计费详单中都会体现这些资源实例和实例上设置的标签。如果您的业务系统是由多个不同的应用构成,为同一种应用拥有的资源实例设置统一的标签将很容易帮助您对不同的应用进行使用量分析和成本核算。 对OBS来说,标签用于标识桶,以此来达到对OBS中的桶进行分类的目的。当为桶添加标签时,该桶上所有请求产生的计费话单里都会带上这些标签,从而可以针对话单报表做分类筛选,进行更详细的成本分析。例如:某个应用程序在运行过程会往桶里上传数据,我们可以用应用名称做为标签,设置到被使用的桶上。在分析话单时,就可以通过应用名称的标签来分析此应用的成本。 OBS以键值对的形式来描述标签。一个桶默认最大拥有10个标签。每个标签有且只有一对键值。键和值可以任意顺序出现在标签中。同一个桶标签的键不能重复,但是值可以重复,并且可以为空。设置桶标签后,大约需要等待3分钟才能生效。
  • 方案说明 OBS提供低成本的存储,华为云CDN可以提供网站加速、文件下载加速和点播加速。将数据存放在OBS中然后通过配置CDN加速,这样构造的业务系统可以在降低成本的同时,提高终端用户使用感受。当终端用户发起访问请求时,会首先通过CDN查找对此域名响应速度最快的CDN节点,并查询此节点是否有缓存终端用户请求的内容。 在CDN节点没有缓存用户请求的数据或缓存到期的情况下,CDN加速访问OBS的示意图如图2所示。 图2 CDN加速访问OBS示意图(CDN无缓存) 当其他终端用户再次访问相同的数据时,CDN将直接返回缓存的数据给终端用户,而无需再向OBS发起访问请求。在CDN有缓存的情况下,CDN加速访问OBS的示意图如图3所示。 图3 CDN加速访问OBS示意图(CDN有缓存) 方案优势 低成本:OBS提供CDN回源流量包折扣方式,使CDN从OBS获取数据时流量费用更低。当数据缓存至CDN节点时,后续请求都将通过CDN回源流量计费,从而减少OBS费用。 高效率:华为云CDN具有加速资源丰富、节点分布广泛优势,保证将用户请求精准调度至最佳边缘节点,提供有效且稳定的加速效果。 适用场景 通过OBS提供文件下载业务的应用或服务。例如:通过http/https提供文件下载业务的网站、工具下载、游戏客户端、APP商店等。 通过OBS提供音视频点播业务的应用或服务。例如:在线教育类网站、在线视频分享网站、互联网电视点播平台、音乐视频点播APP等。
  • 背景介绍 现在越来越多的行业使用OBS存储图片、视频、软件包等静态资源文件,并将OBS作为网站、论坛、APP、游戏等业务的存储源。在需要获取这些静态资源时,用户通过URL直接从OBS请求数据,数据请求过程如图1所示。OBS能够很好的解决本地存储不够用的难题,但一般情况下文件只存储在一个区域,不同区域的用户访问OBS的响应速度存在差异。在需要频繁访问的场景下,直接访问OBS来获取相应文件,还会消耗大量的流量费用。 图1 从OBS获取数据过程
  • 使用场景 一些不良网站想要扩充自己站点内容,但却不想增加成本,于是会盗用其他网站的链接。一方面损害了原网站的合法利益,另一方面又加重了服务器的负担。因此,产生了防盗链技术。 在HTTP协议中,通过表头字段referer,网站可以检测目标网页访问的来源网页。有了referer跟踪来源,就可以通过技术手段来进行处理,一旦检测到来源不是本站即进行阻止或者返回指定的页面。防盗链就是通过设置Referer,去检测请求来源的referer字段信息是否与白名单或黑名单匹配,若与白名单匹配成功则允许请求访问,否则阻止请求访问或返回指定页面。 为了防止用户在OBS的数据被其他人盗链,OBS支持基于HTTP header中表头字段referer的防盗链方法。OBS同时支持访问白名单和访问黑名单的设置。 Referer规则如下: 白名单Referer/黑名单Referer输入的字节数不能超过1024个字符。 Referer格式: Referer可以设置多个,多个Referer换行隔开; Referer参数支持通配符(*)和问号(?),通配符可代替0个或多个字符,问号可代替单个字符; 如果下载时Referer头域包含了http或https,则Referer设置必须包含http或https。 白名单Referer为空,黑名单Referer不空时,允许所有黑名单中指定网站以外的其他网站的请求访问目标桶中的数据。 白名单Referer不为空,黑名单Referer为空或不空时,允许在白名单且不在黑名单中的网站的请求访问目标桶中的数据。 当白名单Referer与黑名单Referer内容有交集时,交集部分Referer被禁止。例如:当白名单Referer与黑名单Referer输入框中的referer字段都有“https://www.example.com”时,系统是阻止该网站的请求访问的。 黑名单Referer与白名单Referer都为空时,默认允许所有网站的请求访问目标桶中的数据。 判断用户是否有对桶及其内容访问的四种权限(读取权限、写入权限、ACL读取权限、ACL写入权限)之前,需要首先检查是否符合referer字段的防盗链规则。 白名单和黑名单设置方法如下: 白名单设置 通过设置白名单,用户可以指定允许来自白名单列表中的网站的请求访问,否则将进行拦截。 通过浏览器地址栏直接访问资源的请求,即HTTP请求中referer为空的场景,用户可以通过在Condition的"Referer"中添加${null}字段,用于指定是否允许referer为空的请求访问。 白名单设置具体参考如下policy设置进行实现: "Statement":[ {"Sid": "1", "Effect": "Allow", "Principal": {"ID":["*"]}, "Action": "*", "Resource":["bucket/*"], }, {"Sid":"2", "Effect":"Deny", "Principal":{"ID":["*"]}, "Action":["*"], "Resource":["bucket/*"], "Condition":{ "StringNotEquals": {"Referer":["http://www.example01.com","${null}"]} } } ] 如果按照此方式设置,只有referer为"www.example01.com"和referer为空的请求可以对桶bucket中的资源进行操作。 黑名单设置 使用访问黑名单功能可以参考如下policy设置进行实现: "Statement":[ {"Sid":"1", "Effect":"Deny", "Principal":{"ID":["*"]}, "Action":["*"], "Resource":["bucket/*"], "Condition":{ "StringEquals": {"Referer":["http://www.example01.com","http://www.example02.com"]} } } ] 如果按照此方式设置,当referer为"www.example01.com"或"www.example02.com"时,就不能对桶bucket中的资源进行操作。
  • 使用场景 用户在使用OBS的过程中会不断发送PUT、GET类的请求,产生上传、下载流量,也可能会遇到服务端返回的错误响应。为使用户更好地掌握OBS桶的状态,华为云提供了云监控服务(Cloud Eye)。用户可使用该服务监控自己的OBS桶,执行自动实时监控、告警和通知操作,帮助您实时掌握桶中所产生的请求、流量和错误响应等信息。 云监控服务不需要开通,会在用户创建资源(如OBS桶)后自动启动。 关于云监控服务的更多介绍,请参见云监控服务产品介绍。 图1 云监控示意图
  • 使用方式 OBS支持通过控制台、API、SDK、OBS Browser+、obsutil方式列举桶。 支持的使用方式 参考文档 控制台 登录控制台并选择“对象存储”,桶列表页将展示账户下所有的桶。 SDK OBS支持多种语言SDK,请从SDK概述页面选择进入对应的开发指南查阅。 API 列举桶 OBS Browser+ 登录OBS Browser+,桶列表页将展示账户下所有的桶。 obsutil 列举桶
  • 使用场景 OBS为您提供了如表1所示的几种统计分析项,帮助您了解如下信息: 表1 用量统计说明 统计类别 统计项 说明 存储 存储总趋势 包含桶中所有对象的存储总量以及桶中的文件总个数趋势。 存储类型趋势 分别统计桶中标准存储、低频访问存储和归档存储三种存储类别的存储容量趋势。不同的存储类别详细介绍请参考存储类别。 存储各类数量趋势 分别统计桶中标准存储、低频访问存储和归档存储三种存储类别的个数趋势。不同的存储类别详细介绍请参考存储类别。 流量 流量趋势 包含公网/内网流入流量和公网/内网流出流量的趋势。 请求 请求趋势 包含请求总数和总请求平均时延趋势。 请求次数 分别统计产生的GET请求、PUT请求和DELETE请求的次数,以及所有请求的次数总和。 请求使用率 分别统计请求的成功率、有效率和中断率。 状态码分布 分别统计产生请求后服务端返回的状态码的分布情况。不同的状态码详细介绍请参考状态码说明。
  • OBS帮助文档概览 对象存储服务OBS提供了一系列文档,帮助您由浅入深地了解和使用对象存储服务OBS。 建议您在使用对象存储服务OBS前,先阅读本文档和其他相关帮助文档(见表1),了解对象存储服务OBS的基本概念、使用场景、使用方式等,从而帮助您更快速、更轻松地使用对象存储服务OBS。 表1 对象存储服务OBS帮助文档 文档 描述 成长地图 对象存储服务OBS帮助内容的汇聚页面。自上而下提供由浅入深的内容指引,通过了解对象存储服务OBS、快速入门、使用指南、最佳实践、问题处理、解决方案等多个模块,帮助您从全局掌握对象存储OBS的帮助信息,让您能轻松、精准地定位到想要查看的内容。 最新动态 对象存储服务OBS功能新增和文档优化的最新动态展示页面,帮助您第一时间了解对象存储服务OBS的最新资讯,新上线功能和文档体验快人一步。 功能总览 对象存储服务OBS功能汇总。您可以清晰地看到OBS支持的功能及功能发布的区域等。 产品介绍 对象存储服务OBS的系统性介绍文档,从服务的常用概念、产品优势、应用场景、计费说明、权限管理等多个方面进行介绍,让您初步了解对象存储服务OBS。 快速入门 对象存储服务OBS的快速使用指导,帮助您快速完成创建桶、上传对象和下载对象的操作。 控制台指南 对象存储服务OBS控制台的详细使用指导,提供了控制台各个功能特性的使用说明,同时提供应用举例帮助您更好地使用对象存储服务OBS控制台。 工具指南 对象存储服务OBS工具(OBS Browser+、obsutil、obsfs)的详细介绍和使用指导,同时提供应用举例帮助您更好地使用对象存储服务OBS工具。 图片处理特性指南 对象存储服务OBS图片处理特性的详细使用指导,从图片处理的基本概念、功能、常见问题等方面,指导您如何通过控制台和API使用图片处理功能。 并行文件系统特性指南 对象存储服务OBS并行文件系统特性的详细使用指导,从并行文件系统的基本概念、应用场景、约束限制、使用方式、计费标准等多个方面进行介绍,帮助您更好的使用并行文件系统。 权限配置指南 对象存储服务OBS权限控制的使用指导。OBS提供多种权限控制方式,包括IAM权限、桶策略、对象ACL、桶ACL,您可以选择应用场景选择合适的方式。 最佳实践 对象存储服务OBS在各个典型场景下的应用实践,帮助您在不同的应用场景下以更优的性能、更低的成本、更便捷地操作使用对象存储服务OBS完成您的业务目标。 API参考 对象存储服务OBS提供的REST API的详细说明文档,详细介绍了各个API的请求示例和参数说明、响应示例和参数说明等信息,帮助您顺利使用API完成二次开发。 SDK参考 对象存储服务OBS软件开发工具包(OBS SDK,Object Storage Service Software Development Kit)的详细使用指导,提供Java、Python、C、GO、Android、IOS等多种主流语言的安装、开发、参数、示例和常见问题处理等内容,帮助您顺利使用SDK完成二次开发。 常见问题 对象存储服务OBS使用过程中的常见问题分类汇总,解答您使用对象存储服务OBS过程中的各种疑问。 视频帮助 对象存储服务OBS介绍、购买和使用的帮助视频,以比文字更加生动的方式向您介绍对象存储服务OBS。 父主题: 使用前须知
  • 使用场景 您可以在已创建的桶中新建一个文件夹,从而更方便的对存储在OBS中的数据进行分类管理。 由于OBS是一种对象存储服务,并没有文件系统中的文件和文件夹概念。为了使用户更方便进行管理数据,OBS提供了一种方式模拟文件夹。实际上在OBS内部是通过在对象的名称中增加“/”,将该对象在OBS管理控制台或者OBS Browser+上模拟成一个文件夹的形式展现。通过API等方式列举对象,获取到的对象名就是以“/”分隔的,最后一个“/”后的内容就是对象名。如果最后一个“/”后没有内容,则表示一个文件夹路径。文件夹的层级结构深度不会影响访问对象的性能。
  • 使用方式 OBS支持通过控制台、API、SDK、OBS Browser+、obsutil方式创建文件夹。 支持的使用方式 参考文档 控制台 新建文件夹 SDK OBS支持多种语言SDK,请从SDK概述页面选择进入对应的开发指南查阅。 说明: 通过SDK创建文件夹,本质上来说是创建了一个大小为0且对象名以“/”结尾的对象。 API - 说明: 通过API创建文件夹,本质上来说是创建了一个大小为0且对象名以“/”结尾的对象。 OBS Browser+ 新建文件夹 obsutil 创建文件夹
  • URI POST /v1/{project_id}/git/repos/{namespace}/{project}/hooks 参数说明见表1。 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。
  • URI GET /v1/{project_id}/git/repos/{namespace}/{project}/hooks 参数说明见表1。 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。
  • URI GET /v1/{project_id}/git/repos/{namespace}/{project}/commits 参数说明见表1。 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。 表2 查询参数 参数 是否必选 类型 描述 ref 否 String 分支名称或者tag名称,如果没有提供,使用默认分支。
  • 基本概念 帐号 用户注册云平台时的帐号,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由帐号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中,您需要用到帐号、用户和密码等信息。 区域(Region) 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 您可以从地区和终端节点中查询服务所在的区域。 可用区(AZ) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 云平台的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 查看项目ID,请参考获取项目ID。 图1 项目隔离模型 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • 请求消息 表3 请求Header参数 参数 是否必选 类型 描述 X-ConsumerId 否 String 微服务消费者唯一标识。 Authorization 是 String 若微服务引擎专享版开启了安全认证,此参数必填。否则,无此参数。 开启了安全认证的微服务引擎专享版Token,格式为: Authorization:Bearer {Token} Token获取方法,请参考获取微服务引擎专享版用户Token。 表4 参数说明 参数 是否必选 类型 描述 services 两个参数至少必须选择一个。 Array of objects 微服务请求结构体,具体参考表5。 instances Array of objects 微服务实例请求结构体,具体参考表6。 表5 FindService参数说明 参数 是否必选 类型 描述 service 是 Object 微服务请求结构体,具体参考DependencyMicroService。 rev 否 String 客户端缓存的版本号,用于判断本地缓存和服务中心微服务的差异。 首次传值0。 若传入的rev值与当前的微服务的rev一致,则返回notModified;若不一致,则返回updated信息。 下次请求若需要传入rev,则该值为当前返回body体中的updated中的rev的值 。 表6 FindInstance参数说明 参数 是否必选 类型 描述 instance 是 Object 微服务实例请求结构体,具体参考HeartbeatSetElement。 rev 否 String 客户端缓存的版本号,用于判断本地缓存和服务中心微服务实例的差异。 首次传值0。 若传入的rev值与当前的微服务实例的rev一致,则返回notModified;若不一致,则返回updated信息。 下次请求若需要传入rev,则该值为当前返回body体中的updated中的rev的值 。
  • 响应示例 { "services": { "updated": [ { "index": 0, "rev": "0feb784798bca7b2fb4de8351578c4437b516c4b", "instances": [ { "instanceId": "79cdaf47cacf43a5b2b4185527da2255", "serviceId": "8aed80ea052ac04a64dfc79c24f2170224d074f5", "endpoints": [ "rest:127.0.0.1:8080" ], "hostName": "hostNameTest", "status": "UP", "properties": { "engineID": "30c263e5-2eac-4da1-9c72-5abb9ac94550", "engineName": "cse-fkln1-HA" }, "healthCheck": { "mode": "push", "interval": 30, "times": 3 }, "timestamp": "1650546183", "modTimestamp": "1650546183", "version": "1.0.0" } ] } ] }}
  • 请求示例 查询应用ID为default,微服务名称为test的微服务的所有实例。 POST /v4/default/registry/instances/action?type=query{ "services": [ { "service": { "environment": "", "appId": "default", "serviceName": "test", "version": "1.0.0" }, "rev": "0" } ]}
  • URI POST /v4/{project_id}/registry/instances/action 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 微服务引擎专业版,请填租户项目id,长度为1~64,获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版,请填固定值:default。 表2 Query参数 参数 是否必选 类型 描述 type 是 String 操作类型。 填固定值:query。
  • 响应消息 参数说明请参见表7。 表7 参数说明 参数 类型 描述 services BatchFindResult 微服务发现的响应结构体。 instances BatchFindResult 微服务实例发现的响应结构体。 表8 BatchFindResult参数说明 参数 类型 描述 failed Array of objects 部分微服务发现失败的响应结构体,具体参考表9。 notModified Array of integers 实例没有发生变化的索引数组,每一项的值对应请求结构体中微服务数组的索引值。 updated Array of objects 实例发生变化的响应结构体,具体参考表10。 表9 FindFailedResult参数说明 参数 类型 描述 indexes Array of integers 微服务发现失败的索引数组,每一项的值对应请求结构体中微服务数组的索引值。 error Object 错误信息结构体,具体参考Error。 表10 FindResult参数说明 参数 类型 描述 index Integer 实例发生变化的索引数组,每一项的值对应请求结构体中微服务数组的索引值。 rev String 返回给客户端缓存的版本号。 instances Array of objects 微服务实例的集合,具体参考MicroServiceInstance。
  • 状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 200 - 操作成功。 304 Not Modified 未修改,所请求的资源未修改返回次状态码。 400 BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 服务器拒绝执行客户端的请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 422 UnprocessableEntity 请求格式正确,但是由于含有语义错误,无法响应。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 父主题: 附录
  • URI POST /v1/{project_id}/git/repos/{namespace}/{project}/tags 参数说明见表1。 表1 路径参数 参数 是否必选 类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 namespace 是 String 命名空间ID或者URL编码名称。获取方法,请参考获取仓库namespaces。 project 是 String 仓库项目ID或者URL编码名称,如果含有“/”,需要将“/”替换为“:”。获取方法,请参考获取命名空间下所有项目。 表2 查询参数 参数 是否必选 类型 描述 ref 是 String 分支名称或者tag名称或者commit sha。
  • 微服务实例接口 表12 微服务实例介绍 API 说明 注册微服务实例 此API用来注册微服务实例。 创建微服务后就可以注册该微服务的实例了。注册微服务实例时,需提供该微服务实例相关的信息。 instanceId可定制,如果定制了,再次注册就直接将全内容覆盖。如果没定制,逻辑如下:系统自动生成id,如果endpoints内容重复,则使用原来的id。 根据serviceId查询微服务实例 此API用来根据serviceId发现该微服务的所有实例。 注销微服务实例 此API用来根据instanceId进行实例注销。 查询微服务实例详细信息 此API用来根据serviceid和instanceId获取该实例的详细信息。 修改微服务实例扩展信息 此API用来根据instanceId添加/更新一个微服务实例扩展信息。 修改微服务实例状态 此API用来根据instanceId更新一个微服务实例状态。 发送心跳信息 此API用来发送心跳信息。 服务提供端需要向服务中心发送心跳信息,以保证服务中心知道服务实例是否健康。 按条件查询微服务实例 此API用来根据微服务版本规则或字段条件发现该微服务的实例。 批量查询微服务实例 此API用来根据微服务版本规则或字段条件批量发现多个微服务的实例。
  • 微服务接口 表10 微服务接口介绍 API 说明 创建微服务静态信息 此API用来创建微服务静态信息。 在注册微服务实例前需要创建微服务静态信息,之后注册的微服务实例根据serviceId这个字段与静态信息关联,一个微服务对应对多个实例。 serviceId可以定制。如果定制了,系统将使用定制的serviceId;如果没定制,系统会随机生成serviceId。 查询指定微服务静态信息 此API用来根据serviceId查询微服务静态信息。 查询所有微服务静态信息 此API用来查询所有的微服务静态信息。 查询微服务唯一标识信息 此API用来指定条件查询微服务serviceId或schema的唯一标识信息。 修改微服务静态信息 此API用来更新微服务静态信息。 创建微服务静态信息后可对服务部分字段进行更新,每次更新都需要传入完整的服务静态信息json,也就是说,即便不更新部分的字段也要作为json的属性传过去。 删除微服务信息 此API用来删除一个微服务定义及其相关信息,同时注销其所有实例信息。 批量删除微服务静态信息 此API用来批量删除指定的微服务定义及其相关信息,同时注销其所有实例信息。
  • 实例接口 表6 实例接口介绍 API 说明 创建组件实例 此API用来创建应用组件实例。 获取应用组件实例 此API用来获取组件下的所有组件实例。 对组件实例的操作 此API用来执行对组件实例的操作。 修改应用组件实例 此API用来修改应用组件实例。 删除应用组件实例 此API用来删除应用组件实例。 根据实例ID获取实例详细信息 此API通过实例ID获取实例详细信息。 获取组件实例快照 此API用来获取应用组件实例快照信息。
  • 应用接口 表4 应用接口介绍 API 说明 创建应用 此API用来创建应用。 获取所有应用 此API用来获取所有已经创建的应用。 修改应用信息 此API通过应用ID修改应用信息。 根据应用ID删除应用 此API通过应用ID删除应用。 根据应用ID获取应用详细信息 此API通过应用ID获取应用详细信息。 修改应用配置信息 此API用来添加或修改应用配置信息。 删除应用配置 此API用来删除应用配置信息。 获取应用配置 此API用来获取应用配置信息。
  • 访问Git仓库接口 表8 访问Git仓库接口介绍 API 说明 获取仓库授权列表 此API用来获取Git仓库所有授权信息。 获取授权重定向URL 此API用来获取授权重定向URL。 创建OAuth授权 此API用来创建OAuth授权。 创建私人令牌授权 此API用来创建私有令牌授权。 创建口令授权 此API用来创建Git仓库口令授权。 删除仓库授权 此API用来通过名称删除仓库授权。 获取仓库namespaces 此API用来获取仓库namespaces。 通过clone url获取仓库信息 此API用来通过clone url获取仓库信息。 获取命名空间下所有项目 此API用来获取命名空间下所有项目。 创建软件仓库项目 此API用来创建软件仓库项目。 获取项目分支 此API用来获取项目分支。 获取项目tags 此API用来获取项目tags。 创建项目tags 此API用来创建项目tags。 删除项目tags 此API用来删除项目tags。 获取项目commits 此API用来获取项目最近10次commits。 获取项目hooks 此API用来获取项目hooks。 创建项目hook 此API用来创建项目hook。 删除项目hook 此API用来删除项目hook。 获取仓库文件目录 此API用来获取仓库文件目录。 获取仓库文件内容 此API用来获取仓库文件内容。 创建仓库文件 此API用来创建仓库文件。 修改仓库文件内容 此API用来修改仓库文件内容。 删除仓库文件 此API用来删除仓库文件内容。
  • URI GET /v2/{project_id}/cas/applications/{application_id}/components/{component_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 application_id 是 String 应用ID。获取方法,请参考获取所有应用。 component_id 是 String 组件ID。获取方法,请参考获取应用所有组件。
共100000条