首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Vsphere REST API -如何在JSON响应中指定字段

Vsphere REST API是VMware提供的一种用于管理Vsphere平台的API接口。它允许用户通过发送HTTP请求与Vsphere进行交互,并执行各种管理操作。

在JSON响应中指定字段可以通过使用Vsphere REST API的查询参数进行实现。具体而言,可以使用"fields"参数来指定在响应中返回的字段。

以下是使用Vsphere REST API进行查询,并在JSON响应中指定字段的示例:

  1. 请求URL:
代码语言:txt
复制
https://<vcenter-server>/rest/<api-path>?fields=<comma-separated-fields>

其中,<vcenter-server>是Vsphere服务器的地址,<api-path>是API的路径,<comma-separated-fields>是要返回的字段,多个字段之间使用逗号分隔。

  1. 示例: 假设我们要查询虚拟机列表,并在JSON响应中只包含虚拟机的名称和IP地址两个字段。

请求URL如下:

代码语言:txt
复制
https://<vcenter-server>/rest/vcenter/vm?fields=name,guest.ipAddress

响应结果类似于以下JSON格式:

代码语言:txt
复制
{
  "value": [
    {
      "name": "VM1",
      "guest": {
        "ipAddress": "192.168.1.100"
      }
    },
    {
      "name": "VM2",
      "guest": {
        "ipAddress": "192.168.1.101"
      }
    }
  ]
}

在这个示例中,我们通过在URL中使用"fields"参数,指定了要返回的字段"name"和"guest.ipAddress"。因此,响应结果中只包含了这两个字段的值。

推荐的腾讯云相关产品:由于无法提及具体品牌商,请参考腾讯云提供的相关虚拟化、云计算服务,例如腾讯云云服务器(CVM)等产品。具体详情请访问腾讯云官方网站。

总结:Vsphere REST API允许用户通过JSON响应中的查询参数来指定返回的字段。使用"fields"参数可以方便地选择所需字段,从而提高API调用的效率和灵活性。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

SpringBootREST API的错误异常处理设计

Restful API错误/异常设计 在RESTful API设计异常处理时,最好在响应设置HTTP状态代码,这样可以表示客户端的请求为什么会失败的原因。...2. error_code表示REST API特定的错误代码。此字段有助于传递API /业务领域中特定信息。比如类似Oracle错误ORA-12345 3. message字段表示人类可读的错误消息。...5. information_link字段指定有关错误或异常的详细信息的链接。 Spring REST错误处理 Spring和Spring Boot提供了许多错误/异常处理选项。...这是在使用基于Spring的REST API时的一种便捷方式,因为可以指定ResponseEntity为返回值。...REST API处理一个个不同的异常,因为所有异常都可以按照上面方式进行类似方式处理。

7K31

GraphQL与传统API对比介绍教程

每个URL代表一种资源,服务器返回的响应包含资源的表示(通常是JSON或XML格式)。优点:简单直观:使用HTTP协议,易于理解和实现。广泛支持:几乎所有的编程语言和框架都支持REST。...GraphQLGraphQL是一种由Facebook开发的查询语言,用于API的数据查询和操作。与REST不同,GraphQL允许客户端明确指定需要的数据,服务器根据查询返回响应。...优点:灵活性高:客户端可以指定需要的字段和嵌套关系,避免冗余数据。单一端点:所有查询通过一个端点完成,简化了API设计。强类型系统:提供了明确的类型定义和验证,减少了错误发生的可能。...版本控制REST:通常通过URL路径(/v1/users)或HTTP头(Accept: application/vnd.api+json;version=1)实现版本控制。...GraphQL:通过模式扩展和字段弃用来处理版本更新,保持API端点不变。开发体验REST:由于其简单性和广泛支持,开发和调试相对容易。

17010
  • 【愚公系列】2022年04月 Python教学课程 77-DRF框架之异常

    文章目录 一、DRF框架自带异常 二、自定义异常 一、DRF框架自带异常 REST 框架的视图处理各种异常,并处理返回适当的错误响应。 处理的异常包括: 在 REST 框架定义的异常。...detail 例如,以下请求: DELETE http://api.example.com/foo/bar HTTP/1.1 Accept: application/json 可能会收到一个错误响应,指示该资源上不允许使用该方法...验证错误的处理方式略有不同,并且将在响应包含字段名称作为键。如果验证错误不是特定于特定字段的,则它将使用“non_field_errors”键,或者为该设置设置设置的任何字符串值。...二、自定义异常 您可以通过创建一个处理程序函数来实现自定义异常处理,该函数将 API 视图中引发的异常转换为响应对象。这允许您控制 API 使用的错误响应样式。...如果未指定,则该设置默认为 REST 框架提供的标准异常处理程序: REST_FRAMEWORK = { 'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler

    1.1K40

    elasticsearch API约定(二)

    前面我们介绍了一些REST API的基本约定,包括多个索引以及索引名称的Date Math支持,本文我们来继续上文的话题,主要来看看公共参数和URL访问控制。...Pretty Results 美化响应JSON格式,当添加 ?pretty=true到请求的后面时,响应JSON将被格式化,这个选项我们在前面的案例已经用过多次了。另一种方案是添加 ?...Number Values 所有的REST API都支持在原生的JSON number基础之上,将numbered parameters作为字符串来提供。...Content-Type Requirements 必须使用Content-Type头信息指定请求正文中发送的内容类型,Content-Type的值必须映射到API支持的一种格式,大多数API支持JSON...批量和多搜索API支持NDJSON,JSON和SMILE,其他类型将导致错误响应。 此外,在使用source查询字符串参数时,必须使用sourcecontenttype查询字符串参数指定内容类型。

    80920

    REST API 设计最佳实践:如何构建、设计和使用 API

    不要返回纯文本 尽管并非强制规定的,但大多数REST API通常约定使用JSON作为数据格式。然而,仅返回包含JSON格式字符串的响应体是不够好的。您还应该指定Content-Type标头。...在处理应用程序/编程客户端(例如,通过Python的requests库与您的API交互的另一个服务/API)时,这一点尤为重要——其中一些客户端依赖于此标头来准确解码响应。 3....在响应返回错误详情 当API服务器处理错误时,将错误详细信息包含在JSON主体可以帮助使用者进行调试,这是是非常方便的,如果您还能说明哪些字段受到了错误的影响,那就更好了!...曾经我不得不集成一个API,它对每个响应都返回200 OK,并通过status字段来表示请求是否成功: { "status": "success", "data": {} } 尽管HTTP...使用专门针对REST API的网络框架 作为最后一个最佳实践,让我们讨论这个问题:如何在您的API实际应用最佳实践?大多数时候,您希望建立一个快速的API,以便一些服务可以相互交互。

    40540

    13 个设计 REST API 的最佳实践

    不要返回纯文本 虽然返回 JSON 数据格式的数据不是 REST 架构规范强制限定的,但大多 REST API 都遵循这条准则。...但是,仅仅返回 JSON 数据格式的数据还是不够的,你还需要指定返回 body 的头部,比如 Content-Type,它的值必须指定为 application/json。...在响应返回错误详情 当 API 服务器处理错误时,如果能够在返回的 JSON body 包含错误信息,对于接口调用者来说,会一定程度上帮助他们完成调试。...当然可以,不过让我讲一个故事: 我曾经使用过一个 API,对于它返回的所有响应的状态码均是 200 OK,同时通过响应数据的 status 字段来表示当前的请求是否成功,比如: {...采用 REST API 定制化的框架 作为最后一个最佳实践,让我们来探讨这样一个问题:你如何在 API 的实施,实践最佳实践呢?

    3.5K20

    你了解过系统集成服务集成交互技术:REST服务集成——RESTAPI吗

    RESTJSON 在服务集成交互技术,我们已经介绍了两种主要的基于文本的序列化方式:JSON和XML。...一种资源可能有多种表述形式,而URI应该只代表资源的位置,它的具体表述形式应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对“表现层”的描述。...Level 3:API基于HATEOAS原则设计,简单地说就是响应消息包含后续操作的URI资源,Level 3拥有协议自描述功能。...● URL内参数包含可变字段/orders/orderid,orderid为URL内参数,需要对应填值,具体参考下文的接口列表。...【返回结果】 API接口使用标准HTTP返回码,只有2XX才是正确返回,下面是可能的返回码汇总: ● 200,请求成功,具体请求结果参考响应内容JSON值。

    1.4K20

    Spring Boot处理REST API错误的正确姿势

    这个响应信息确实提供了一些不错的字段,但是它更侧重的时候抛出一个底层的变成异常。顺便说一句,这是Spring Boot的DefaultErrorAttributes类。...时间戳字段是一个整数,甚至不携带时间戳所在的度量单位的信息。异常字段的话,可能只有Java开发人员看到这个比较开心,这些信息让API消费者也陷入了思索API服务端究竟发生了什么内部的编程错误。...如果我们从这些编程异常的内容抽象出更多的细节是不是更好一点?那么就让我们学习下如何正确地处理这些异常,并将它们转成更好的JSON表示形式,使我们的API客户端理解起来更加的轻松。...它表示在REST调用期间遇到的验证问题的类。 下面,你将看到在我们实现了这里所做的改进之后生成的JSON响应的例子,仅仅是为了了解本文接下来的内容。...下面就是我们扩展后的REST调用的响应json: ?

    3.5K130

    API架构】使用 JSON API 的好处

    JSONAPI.org 描述的 JSON API 非常适合使您的 JSON 响应格式更加一致。以提高生产力和效率为目标,JSON API 因其可以消除多余的服务器请求的高效缓存功能而受到吹捧。...,而不指定媒体类型参数: Content-Type: application/vnd.api+json JSON API 表示如何调用资源以及如何共享相关链接。...+json 稀疏字段集是一种标准化方法,它允许客户端仅指定他们希望从对象包含在响应的属性。...JSON API何在实践中使用:FitBit 案例研究 让我们看看 JSON API何在实践实现以设计高效的 API,使用 FitBit 作为现实生活的案例研究。...如上所述,让客户端和服务器共享一个通用数据模型( JSON API)有很多优点。

    2.7K20

    ElasticSearch高版本API的使用姿势

    现在项目中用了7.1.1版本的ElasticSearch,API用的是elasticsearch-rest-high-level-client7.1.1,为了能完成任务,我也只是去看了怎么去用。...今天分享下,如何在Java项目中使用elasticsearch-rest-high-level-client。 直接http接口调用 ?...基于API封装便用方式 添加elasticsearch-rest-high-level-client依赖。...为了方便,我将在创建索引的动作写在代码,当判断环境为dev环境时,删除索引重建。因此,我也封装了创建索引的逻辑。 首先是定义一个注解,用于注释在实体类的字段上,用于创建索引时构造mapping。...* 不转中间对象,直接转为json字符串,避免批量插入浪费内存资源 */ private String jsonData; } 提供将任意对象转为EsEntity的静态方法,支持指定id

    2K30

    安息吧 REST API,GraphQL 长存

    对于这两种情况,请求都是一个简单的字符串,GraphQL 服务可以使用指定格式的数据解释,执行和解析。通常用于移动和 Web 应用的响应格式为 JSON。 什么是 GraphQL?...例如,客户端不能指定为该资源的记录选择哪些字段。这意味着 REST API 服务将始终返回所有字段,而不管客户端实际需要哪些。GraphQL 针对这个问题定义的术语是超量获取不需要的信息。...UI 使用了我们假想的 JSON 数据对象的所有“键”。 现在我们来看看如何使用 RESTful API 请求这些数据。...采用 JSON 响应,移除所有“答案”部分(键所对应的值),最后得到一个非常适合代表关于该 JSON 响应的问题的 GraphQL 查询。...如果我们有一个 GraphQL 查询,我们明确知道如何在 UI 中使用它的响应,因为查询与响应具有相同的“结构”。我们不需要检查响应才知道如何使用它,我们也不需要有关 API 的任何文档。

    2.7K30

    REST API设计指导——译自Microsoft REST API Guidelines(四)

    有的服务(接口)可以在响应增加字段而不修改接口版本号。 如果有这种情况,接口文档必须进行清晰明确地说明,并且客户端必须忽略掉这些未知的字段。...客户端处理响应数据时一定不能依赖服务端JSON 响应数据字段的顺序。 PS:不要硬编码,JSON反序列化了解一下。...例如,当服务器返回的 JSON 对象字段顺序变了,客户端应当能够正确进行解析处理。...PS:ODATA了解下,不仅能排序,还能指定字段顺序。...Prefer  | 返回=极小值 ,返回=代表事物 | 如果指定了返回=最小优先级,则服务应响应成功插入或更新返回空主体。如果指定了Reale=表示,服务应该返回响应创建的或更新的资源。

    2K50

    Microsoft REST API指南

    :实现或必须与某些外部定义的REST API互操作的REST服务必须与哪些外部的API兼容,而无法遵循这些准则。而还有一些服务也可能具有需要特殊性能需求,必须采用其他格式,例如二进制协议。...在服务迭代的过程,有些服务(接口)可能在不更改版本号的情况下向响应添加字段。此类服务必须在其文档中注明,客户端必须忽略这些未知字段。...[*]译者注:一个已发布的在线接口服务,如果不修改版本而增加字段,那么一定不能影响已有的客户端调用。 6.2 变量排序规则 客户端处理响应数据时一定不能依赖服务端JSON响应数据字段的顺序。...例如,服务端可以每次返回 JSON 对象时都把 JSON 对象的类型信息作为第一个字段返回,进而简化客户端解析返回数据格式的难度。客户端处理数据时可以依赖于服务端明确指定了的排序行为。...在常规表示返回添加/修改的项,允许客户端使用基于“id”字段的标准合并概念将它们合并到现有的“缓存”。 从定义的集合删除的条目必须包含在响应

    4.6K10

    5个REST API安全准则

    当开发REST API时,从一开始就必须注意安全方面。 REST是通过URL路径元素表达系统特定实体的手段。REST不是一个架构,而是一种在Web上构建服务的架构风格。...(3)验证响应类型 REST服务通常允许多种响应类型(例如application / xml或application / json,客户端通过请求的Accept头指定响应类型的首选顺序)。...(2)JSON编码 JSON编码器的一个关键问题是阻止在浏览器执行任意JavaScript远程代码...或者,如果您在服务器上使用node.js。...200 OK -回应一个成功的REST API的行动。HTTP方法可以是GET,POST,PUT,PATCH或DELETE。 400错误请求 -请求格式错误,消息正文格式错误。...概要 在这篇文章,介绍了5个RESTful API安全问题和如何解决这些问题的指南。遵循这些准则将导致更安全和高质量的REST API服务和更多的开发人员友好的REST API

    3.7K10

    使用 GraphQL 和 Ballerina 操作多个数据源

    GraphQL 是更好的 REST 在过去的十年REST 已经成为一种流行的 API 设计架构。...因此,为了满足新的需求,需要调整 REST API。如果使用的是 GraphQL,由于客户端可以指定准确的数据需求,所以只需要在客户端做出更改,服务器端不需要做任何额外的工作。...在创建所需的记录之前,需要分析一下根据指定 ISBN 从 Google Books API 获取的的 JSON 响应消息的格式。它返回一个 JSON 对象,其中包含了一个“items”的数组。...然后,你通过指定要监听的端口来创建 GraphQL 监听器对象,并将其附加到服务上。 资源方法以 REST 的方式公开服务,而远程方法则以过程方式公开服务。...你可以看到这里的一些评级是“null”,因为 Google Books API 调用返回的一些 JSON 响应没有包含这些信息。

    2.4K20

    API架构】REST API 行业辩论:OData vs GraphQL vs ORDS

    符合 REST 的 Web 服务允许请求系统使用一组统一且预定义的无状态操作来访问和操作 Web 资源的文本表示。RESTful 实现使用 HTTP、URI、JSON 和 XML 等标准。...GraphQL 通过强制客户端准确指定他们需要哪些字段来解决 API 版本控制和维护问题。API 开发人员可以主动联系已知的字段使用者,以迁移已弃用的字段响应包括有关哪些字段已弃用的信息。...OData 通过提供一个选择列表来将返回的字段数限制为应用程序所需的字段数,从而提供类似的功能。这减少了应用程序响应大小和处理。但是,它没有提供一种机制来指示字段已被弃用。...例子 为了直观地说明使用这些 API 的差异,以下两个代码示例展示了如何在 GraphQL 和 OData 执行“排序依据”。...您执行 POST,准确定义要包含在响应字段和函数。 因此,尽管 GraphQL 使您能够从元数据确定哪些字段和函数可用,但您仍然不知道它们在语义上的含义。

    2.1K30

    前端要知道的RESTful API架构风格

    Representational:在整个词语中表示“数据的表现形式”,JSON、XML……),REST其实对数据的传输是不做任何限制的,尽管它不做任何限制,但我们在写REST服务时的最佳实践还是用JSON...RESTful API 设计最佳实践 请求设计规范 URI 使用名词,尽量用复数,/users URI 使用嵌套标识关联关系, /users/12/repos/5 使用正确的HTTP方法,GET/...意思是每一个响应都是可以被查询的、都是可以被过滤的,我们给接口加上一些限制条件就只能返回符合这些条件的结果。 分页。本质上也是一种查询,如果列表信息非常长的话应该加上分页信息 字段过滤。...只返回你指定字段 状态码。选择正确的状态作为返回状态 错误处理。...DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物 状态码,服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号是该状态码对应的HTTP动词)。

    89430

    Spring Boot REST API错误处理指南

    本文将介绍在使用Spring Boot构建REST API的时候如何进行合适的错误处理。 ? 在过去几年里,使用Spring构建REST API已经成为Java开发人员的标准方法。...让错误响应更清晰 在本文中,我们将实现一个通过REST API来检索鸟类(代表一个对象)的应用程序,代码托管在GitHub上。这个示例包含了本文描述的所有功能,以及比较多的错误处理场景。...exception字段只有Java开发人员会感兴趣,该消息使API消费者迷失在与它们无关的细节。是否有更多的细节可以从错误产生的异常中提取出来呢?...下面,你将看到几个JSON响应的例子,这些响应根据我们上面的描述做了改进。...这里另外还有一些资源,可对本文起到补充作用: Baeldung - 使用Spring对REST进行错误处理 Spring Blog - Spring MVC的异常处理 了解基础知识 为什么API应有一个统一的错误格式

    3.3K20
    领券