主要内容

weboptions

指定参数RESTful web服务

描述

例子

选择= weboptions返回一个默认weboptions对象指定参数请求到一个web服务。一个weboptions对象可以是一个可选的输入参数webread,websave,webwrite功能。对于不支持的选项金宝appweboptions功能,请参见HTTP接口

例子

选择= weboptions (名称,值)指定的一个或多个属性weboptions对象。

例子

默认的weboptions对象

创建一个默认的weboptions对象和显示其属性的默认值。

选择= weboptions
选择= weboptions属性:CharacterEncoding:“汽车”UserAgent:“MATLAB 9.7.0.1112323 (R2019b)超时:5用户名:密码:“KeyName: KeyValue:“ContentType:“汽车”ContentReader: [] MediaType:“汽车”RequestMethod:“汽车”ArrayFormat:“csv”HeaderFields: [] CertificateFilename:“违约”

用户名和密码在weboptions对象

设置您的web服务的用户名和密码weboptions对象。您可以使用对象作为输入参数webread,websave,或webwrite当您的web服务需要身份验证。

选择= weboptions (“用户名”,“jdoe”,“密码”,“我的密码”);

当你显示密码了weboptions对象。然而,对象存储密码以纯文本。您可以检索密码的weboptions.Password财产。

options.Password
ans = '我的密码'

输入参数

全部折叠

名称-值参数

指定可选的逗号分隔条名称,值参数。的名字参数名称和吗价值相应的价值。的名字必须出现在引号。您可以指定几个名称和值对参数在任何顺序Name1, Value1,…,的家

例子:weboptions(“超时”,60)创建一个weboptions对象设置连接超时时间为60秒。

所使用的编码webread将web内容转换为字符,指定为一个字符串标量或特征向量。常见的编码包括“us - ascii”,“utf - 8”,“latin1”中的一个,“Shift_JIS”,“iso - 8859 - 1”。默认编码依赖于内容类型。如果你得到的文本,然后webread所使用的编码可能不同于编码文档。尝试设置CharacterEncodingutf - 8

用户代理识别、指定为一个字符串标量或字符向量表示客户端用户代理。

超时连接持续时间以秒为单位指定为一个积极的数字标量。值是等待的秒数来接收来自服务器的最初反应(头)后发送一个请求的最后包。超时等于ResponseTimeout财产的matlab.net.http.HTTPOptions类。最大值为2147.483647秒。使用设置最大值。

有些操作系统有最大超时由系统执行。这超时的值即使生效超时大于最大值。例如,在Windows上®10,这是21秒超时。

指定的用户标识符,作为基本的字符串标量或特征向量和/或消化HTTP身份验证(不加密)。基本的HTTP身份验证方案的信息,请参阅https://tools.ietf.org/html/rfc7617。HTTP消化访问身份验证信息,请参阅https://tools.ietf.org/html/rfc7616

指定用户身份验证密码,作为基本的字符串标量或特征向量和/或消化HTTP身份验证(不加密)。如果你显示weboptions对象与密码设置,那么该值显示为一个特征向量包含‘*’。然而,对象存储的值密码为纯文本。

名字的一个关键的,指定为字符串标量或特征向量。KeyName是一个额外的名称添加到HTTP请求头。例如,KeyName可以是一个web服务API键名。

例子:weboptions (‘KeyName’,‘时间’,‘KeyValue’, 7)创建一个weboptions对象,该对象包含一个键名,持续时间,定义为一个web服务。

值的一个关键,指定为字符串标量,特征向量,或数字或逻辑值添加到HTTP请求头。KeyValue规定的值是一个关键KeyName

例子:weboptions (‘KeyName’,‘时间’,‘KeyValue’, 7)创建一个weboptions对象,该对象包含一个键值,7搭配了一个关键的名字,持续时间

头字段名称和值,指定为一个字符串m-by-2数组或单元阵列特征向量添加到HTTP请求头。HeaderFields{1},我一个字段的名称和吗HeaderFields{2},我是它的价值。

这些头字段添加或替换字段自动添加webread,webwrite,或websave。通常这些字段的添加,但如果其中一个字段的名称不区分大小写匹配的字段会自动添加,和该字段不支持多个值(例如,- type),然后使用您所指定的值。金宝app一些字段的值是必要的成功发送一个请求,如连接和内容长度,不能覆盖。

例子:weboptions (HeaderFields,{内容长度”的“78”;“内容类型”“application / json”})创建一个weboptions对象包含两个头字段:内容长度与价值78年内容类型与价值application / json

内容类型,指定为字符串标量或特征向量。使用ContentType优先请求,服务器返回数据在一个特定的格式。webread使用这个值来将响应转换为MATLAB®类型。服务器返回这个内容类型如果可能,但没有义务这么做。

ContentType说明符

输出类型

“汽车”(默认)

输出类型自动确定基于内容类型指定的服务器。

“文本”

内容类型的特征向量:

文本/平原
text / html
text / xml
应用程序/ xml
应用程序/ javascript
应用程序/ x-javascript
应用程序/ x-www-form-urlencoded

如果一个web服务返回一个MATLAB文件。m扩展函数返回它的内容作为一个特征向量。

“图像”

数字或逻辑矩阵图像/格式内容。如果第一个参数是输出索引图像,第二个输出参数是colormap,第三个参数是alpha通道输出。

支持图像金宝app格式,请参阅金宝app支持文件格式导入和导出

“音频”

数字矩阵音频/格式内容与数字标量采样率为第二个输出参数。

支持的音金宝app频格式,请参阅金宝app支持文件格式导入和导出

“二元”

uint8列向量为二进制内容(内容不被视为类型字符)。

“表”

为电子表格和CSV(标量表对象文本/ csv)的内容。

json的

字符、数字、逻辑结构,或单元阵列application / json内容。

“xmldom”

Java®文档对象模型(DOM)节点text / xml应用程序/ xml内容。如果未指定,则函数返回XML内容作为特征向量。

“生”

字符列向量为“文本”,“xmldom”,json的内容。函数返回任何其他内容类型uint8列向量。

例子:weboptions (“ContentType”、“文本”)创建一个weboptions对象,指示webread返回文本、JSON或XML内容作为特征向量。

内容的读者,指定为一个函数处理。您可以创建一个weboptions对象与ContentReader指定,并通过对象作为输入参数webread。然后webread从web服务下载数据并与指定的函数读取数据处理函数。webread忽略了ContentTypeContentReader都是确定的。

例子:weboptions (ContentReader, @readtable)创建一个weboptions对象,指示webread使用readtable阅读内容表。

媒体类型,指定为字符串标量,特征向量,或matlab.net.http.MediaType对象。MediaType指定的数据类型webwrite发送给web服务。它指定了MATLAB指定服务器的内容类型,它控制webwrite数据论点,如果指定转换。有关更多信息,请参见https://tools.ietf.org/html/rfc6838

默认值是“汽车”这表明MATLAB选择基于输入类型webwrite。如果使用PostName / PostValue参数对,然后用MATLAB使用“应用程序/ x-www-form-urlencoded”把双。如果使用数据认为是一个标量字符串或字符向量,然后用MATLAB假定这是一个表单编码的字符串并将其发送按原样使用“应用程序/ x-www-form-urlencoded”。如果数据MATLAB是什么,然后将其转换为JSON使用吗jsonencode并使用内容类型“application / json”

如果你指定一个MediaType包含json的javascript的,数据是一个特征向量,然后按原样发送。所有其他类型,包括标量字符串,使用转换jsonencode

如果您指定“应用程序/ x-www-form-urlencoded”,然后PostName / PostValue对发送表单编码。数据,如果存在,必须发送一个字符串或字符向量按原样。

如果你指定一个MediaType包含“xml”,数据是一个文档对象模型对象(Javaorg.apache.xerces.dom.DocumentImpl),然后它被转换为XML。数据,如果存在,必须发送一个字符串或字符向量按原样。

如果你指定的任何其他MediaType,数据是一个字符串或字符向量,然后呢weboptions发送初始值。

PostName / PostValue对只接受MediaType“汽车”“应用程序/ x-www-form-urlencoded”,和特征向量总是发送初始不管MediaType

您可以指定以分号分隔名称=值内的参数MediaType例如,字符串application / json的;odata =冗长的'。一些服务器需要这种格式的content - type头字段的请求。

例子:weboptions (“MediaType”、“application / json”)创建一个weboptions对象,指示webwrite对字符进行编码矢量数据为JSON发布到一个web服务。

HTTP请求方法,指定为一个字符串标量,特征向量,或matlab.net.http.RequestMethod枚举这些值之一:

  • “汽车”

    • webreadwebsave使用HTTP GET方法。

    • webwrite使用HTTP POST方法。

  • “得到”为使用webreadwebsave功能。

  • “职位”为使用webread,webwrite,websave功能。

  • “把”为使用webread,webwrite,websave功能。

  • “删除”为使用webread,webwrite,websave功能。

  • “补丁”为使用webread,webwrite,websave功能。

webreadwebsave函数把查询URL不管RequestMethodwebwrite将查询到的数据无论RequestMethod

例子:weboptions (“RequestMethod”、“文章”)创建一个weboptions对象,指示webread,websave,或webwrite使用web服务的HTTP POST方法。

格式form-encode查询或发布值表示多个值,指定为“csv”,json的,“重复”,或“php”。一个查询或发布值如果是包含多个值

  • 一个数字、逻辑或datetime向量

  • 与超过一行字符数组

  • 细胞的向量,其中每个元素是一个数字,逻辑,或datetime标量或与一行一个特征向量

不支持其他数据类型或维度。金宝app

此表显示了每个表单编码的转换格式,命名为一个查询参数“参数”和一个查询的值(1 2 3)。web服务指定要使用的转换。

ArrayFormat说明符

表单编码的转换

“csv”(默认)

参数= 1、2、3

json的

参数= (1、2、3)

“重复”

参数= 1参数= 2参数= 3

“php”

参数[]= 1参数[]= 2参数[]= 3

编码一个标量是一个元素的数组json的“php”说明符,将一个元素的单元阵列的标量。

例子:weboptions (“ArrayFormat”、“重复”)创建一个weboptions对象,指示webread,websave,或webwriteform-encode任何查询或发布价值与多个值重复查询参数。

文件名称,指定为字符串标量或字符向量表示一个文件的名称和位置包含根证书。文件必须在privacy-enhanced邮件(PEM)格式。必须在当前文件夹的位置,在MATLAB上一个文件夹路径,或者一个完整或相对路径文件。这个文件中包含的证书验证服务器证书用于HTTPS连接。因为安全的HTTPS连接取决于这个文件的完整性,请适当地保护它。MATLAB不管理证书或证明文件,但也有第三方工具用于管理PEM文件。

默认情况下如果不指定选项,MATLAB验证服务器证书使用系统提供的证书存储。如果这也是行为CertificateFilename被设置为“默认”

如果CertificateFilename是空的(),然后关闭服务器的验证证书。MATLAB只有验证域名的服务器证书匹配的服务器。

如果你遇到一个服务器证书验证失败“默认”使用系统浏览器,然后检查连接。

如果你遇到一个连接问题,考虑以下:

  • 或撤销服务器证书过期,网站所有者或服务器管理员联系。

  • 失踪的根CA证书,你可以选择以下之一:

    • 根CA证书添加到文件用CertificateFilename

    • 通过设置禁用证书验证CertificateFilename空()。

  • 之间的不匹配的域名服务器证书和服务器的域名,您可以禁用这个验证通过创建一个matlab.net.http.RequestMessage对象和设置matlab.net.http.HTTPOptions.VerifyServerName财产

请注意

这些选项是临时工作区和MathWorks强烈建议您解决任何服务器证书验证失败的根源,使用一个有效的/正确的服务器证书。

属性:

GetAccess

公共

SetAccess

公共

介绍了R2014b