文档首页 > > 开发指南> 服务集成开发指导> 函数API脚本开发>

HttpConfig类说明

HttpConfig类说明

分享
更新时间:2021/04/08 GMT+08:00

路径

com.roma.apic.livedata.config.v1.HttpConfig

说明

配合HttpClient使用,对HTTP请求进行配置。

使用示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
importClass(com.roma.apic.livedata.client.v1.HttpClient);
importClass(com.roma.apic.livedata.config.v1.HttpConfig);
function execute(data) {
    var requestConfig = new HttpConfig();

    requestConfig.setAccessKey("071fe245-9cf6-4d75-822d-c29945a1e06a");
    requestConfig.setSecretKey("c6e52419-2270-****-****-ae7fdd01dcd5");

    requestConfig.setMethod('POST');
    requestConfig.setUrl("https://30030113-3657-4fb6-a7ef-90764239b038.apigw.exampleRegion.com/app1");
    requestConfig.setContent("body");
    requestConfig.setContentType('application/json');

    var client = new HttpClient();
    var resp =  client.request(requestConfig);
    return resp.body().string()
}

构造器详情

public HttpConfig()

构造一个无参数的HttpConfig

方法列表

返回类型

方法和说明

void

addHeaderToSign(String headerName)

添加待签名的请求头

String

getAccessKey()

获取签名的AccessKey。设置了AccessKey和SecretKey的请求将使用AKSK签名算法对请求签名。

String

getCaCertData()

获取Ca证书

String

getCharset()

获取HTTP请求编码格式

String

getClientCertData()

获取客户端证书

String

getClientKeyAlgo()

获取客户端私钥加密算法

String

getClientKeyData()

获取客户端私钥

String

getClientKeyPassphrase()

获取客户端私钥密码

int

getConnectionTimeout()

获取连接超时时间

int

getConnectTimeout()

获取连接超时时间

Object

getContent()

获取HTTP请求内容

String

getContentType()

获取HTTP请求内容格式

String

getHeader(String name)

获取指定名称的HTTP请求头

Set<String>

getHeaderNames()

获取请求头名称

Map<String,String[]>

getHeaders()

获取所有请求头

String[]

getHeaders(String name)

获取指定名称的所有HTTP请求头

Set<String>

getHeadersToSign()

获取待签名的请求头

String

getHttpProxy()

获取Http代理

String

getHttpsProxy()

获取Https代理

int

getMaxConcurrentRequests()

获取maxConcurrentRequests

int

getMaxConcurrentRequests...()

获取maxConcurrentRequestsPerHost

String

getMethod()

获取HTTP方法

String[]

getNoProxy()

获取不使用代理的IP地址列表

String

getParameter(String name)

获取指定名称的HTTP请求参数

Set<String>

getParameterNames()

获取所有HTTP请求参数名称

Map<String,String>

getParameters()

获取HTTP请求参数

String

getProxyPassword()

获取代理密码

String

getProxyUsername()

获取代理用户名

RequestConfig

getRequestConfig()

获取请求配置信息

String

getRequestId()

获取请求编号

int

getRequestTimeout()

获取请求超时时间

long

getRollingTimeout()

获取rolling超时时间

long

getScaleTimeout()

获取scale超时时间

String

getSecretKey()

获取请求签名的SecretKey。设置了AccessKey和SecretKey的请求将使用AKSK签名算法对请求签名。

okhttp3.TlsVersion[]

getTlsVersions()

获取TLS版本

String

getUrl()

获取Url

String

getUserAgent()

获取userAgent

long

getWebsocketPingInterval()

获取websocket心跳时间

long

getWebsocketTimeout()

获取websocket超时时间

boolean

isRedirects()

是否允许重定向

boolean

isSsl()

是否使用HTTPS,默认false

boolean

isSslRedirects()

获取sslRedirects的值,取值:true or false

boolean

isTrustCerts()

是否信任所有证书,取值:true or false

void

setAccessKey(String accessKey)

设置请求签名的AccessKey。设置了AccessKey和SecretKey的请求将使用AKSK签名算法对请求签名。

void

setBodyForm(Map<String,String> content)

设置map类型的HTTP请求内容

void

setBodyText(String content)

设置String格式的HTTP请求内容

void

setCaCertData(String caCertData)

设置Ca证书

void

setCharset(String charset)

设置HTTP请求编码格式

void

setClientCertData(String clientCertData)

设置客户端证书

void

setClientKeyAlgo(String clientKeyAlgo)

设置客户端私钥加密算法

void

setClientKeyData(String clientKeyData)

设置客户端私钥

void

setClientKeyPassphrase(String clientKeyPassphrase)

设置客户端私钥密码

void

setConnectionTimeout(int connectionTimeout)

设置连接超时时间

void

setConnectTimeout(int connectTimeout)

设置连接超时时间

void

setContent(Object content)

设置Object格式的HTTP请求内容

void

setContentType(String contentType)

设置HTTP请求内容格式

void

setHeader(String name, String value)

设置指定名称和值的请求头

void

setHeader(String name, String[] value)

设置指定名称和值的请求头

void

setHeaders(Map<String,String> headers)

设置请求头

void

setHeaderValues(Map<String,String[]> headers)

设置请求头

void

setHttpProxy(String httpProxy)

设置http代理

void

setHttpsProxy(String httpsProxy)

设置Https代理

void

setMaxConcurrentRequests(int maxConcurrentRequests)

设置最大并发数

void

setMaxConcurrentRequests...(int maxConcurrentRequestsPerHost)

设置单域名最大并发数

void

setMethod(String method)

设置HTTP方法

void

setNoProxy(String[] noProxy)

设置不使用代理的地址列表

void

setParameter(String name, String value)

设置HTTP请求参数

void

setParameters(java.util.Map<String,String> parameters)

设置HTTP请求参数

void

setProxyPassword(String proxyPassword)

设置proxy密码

void

setProxyUsername(String proxyUsername)

设置proxy用户名

void

setRedirects(boolean redirects)

设置是否允许重定向

void

setRequestId(String requestId)

设置请求编号

void

setRequestTimeout(int requestTimeout)

设置请求超时时间

void

setRollingTimeout(long rollingTimeout)

设置rolling超时时间

void

setScaleTimeout(long scaleTimeout)

设置scale超时时间

void

setSecretKey(String secretKey)

设置请求签名的SecretKey。设置了AccessKey和SecretKey的请求将使用AKSK签名算法对请求签名。

void

setSsl(boolean ssl)

设置是否使用HTTPS

void

setSslRedirects(boolean sslRedirects)

设置sslRedirects的值

void

setTlsVersions(okhttp3.TlsVersion[] tlsVersions)

设置TLS版本

void

setTrustCerts(boolean trustCerts)

设置是否信任所有证书

void

setUrl(String url)

设置Url

void

setUserAgent(String userAgent)

设置userAgent

void

setWebsocketPingInterval(long websocketPingInterval)

设置websocket心跳时间

void

setWebsocketTimeout(long websocketTimeout)

设置websocket超时时间

方法详情

  • public void addHeaderToSign(String headerName)

    向签名中添加header

    输入参数

    headerName:请求头名称

  • public String getAccessKey()

    获取请求签名的AccessKey。设置了AccessKey和SecretKey的请求将使用AKSK签名算法对请求签名。

    返回信息

    返回请求签名的AccessKey

  • public String getCaCertData()

    获取Ca证书

    返回信息

    返回Ca证书

  • public String getCharset()

    获取HTTP请求编码格式

    返回信息

    返回HTTP请求编码格式

  • public String getClientCertData()

    获取客户端证书

    返回信息

    返回客户端证书

  • public String getClientKeyAlgo()

    获取客户端私钥加密算法

    返回信息

    返回客户端私钥加密算法

  • public String getClientKeyData()

    获取客户端私钥

    返回信息

    返回客户端私钥a

  • public String getClientKeyPassphrase()

    获取客户端私钥密码

    返回信息

    返回客户端私钥密码

  • public int getConnectionTimeout()

    获取连接超时时间

    返回信息

    返回连接超时时间

  • public int getConnectTimeout()

    获取连接超时时间

    返回信息

    返回连接超时时间

  • public Object getContent()

    获取HTTP请求内容

    返回信息

    返回HTTP请求内容

  • public String getContentType()

    获取HTTP请求内容的格式

    返回信息

    返回HTTP请求内容的格式

  • public String getHeader(String name)

    获取指定名称的HTTP请求头

    输入参数

    name:请求头名称

    返回信息

    返回指定名称的请求头信息

  • public Set<String> getHeaderNames()

    获取请求头名称

    返回信息

    返回请求头名称

  • public Map<String,String[]> getHeaders()

    获取所有请求头

    返回信息

    返回所有请求头

  • public String[] getHeaders(String name)

    获取指定名称的所有HTTP请求头

    输入参数

    name:请求头名称

    返回信息

    返回指定名称的所有HTTP请求头

  • public Set<String> getHeadersToSign()

    获取签名中的请求头

    返回信息

    返回签名中的请求头

  • public String getHttpProxy()

    获取Http代理

    返回信息

    返回Http代理

  • public String getHttpsProxy()

    获取Https代理

    返回信息

    返回Https代理

  • public int getMaxConcurrentRequests()

    获取最大并发数

    返回信息

    返回最大并发数

  • public int getMaxConcurrentRequestsPerHost()

    获取单域名最大并发数

    返回信息

    返回单域名最大并发数

  • public String getMethod()

    获取HTTP方法

    返回信息

    返回HTTP方法

  • public String[] getNoProxy()

    获取不使用代理的地址列表

    返回信息

    返回不使用代理的地址列表

  • public String getParameter(String name)

    获取指定名称的参数

    输入参数

    name:HTTP的名称

    返回信息

    返回指定名称的参数

  • public Set<String> getParameterNames()

    获取HTTP请求参数

    返回信息

    返回HTTP请求参数

  • public Map<String,String> getParameters()

    获取HTTP请求参数

    返回信息

    返回HTTP请求参数

  • public String getProxyPassword()

    获取Proxy密码

    返回信息

    返回Proxy密码

  • public String getProxyUsername()

    获取Proxy用户名

    返回信息

    返回Proxy用户名

  • public RequestConfig getRequestConfig()

    获取requestConfig

    返回信息

    返回sslRedirects的布尔值

  • public String getRequestId()

    获取请求编号

    返回信息

    返回请求编号

  • public int getRequestTimeout()

    获取请求超时时间

    返回信息

    返回请求超时时间

  • public long getRollingTimeout()

    获取rolling超时时间

    返回信息

    返回rolling超时时间

  • public long getScaleTimeout()

    获取scale超时时间

    返回信息

    返回scale超时时间

  • public String getSecretKey()

    获取请求签名的SecretKey。设置了AccessKey和SecretKey的请求将使用AKSK签名算法对请求签名。

    返回信息

    返回请求签名的SecretKey

  • public okhttp3.TlsVersion[] getTlsVersions()

    获取TLS版本号

    返回信息

    返回TLS版本号

  • public String getUrl()

    获取Url

    返回信息

    返回Url

  • public String getUserAgent()

    获取userAgent

    返回信息

    返回userAgent

  • public long getWebsocketPingInterval()

    获取websocket心跳时间

    返回信息

    返回websocket心跳时间

  • public long getWebsocketTimeout()

    获取Websocket超时时间

    返回信息

    返回Websocket超时时间

  • public boolean isRedirects()

    是否允许重定向

    返回信息

    返回允许/不允许重定向

  • public boolean isSsl()

    是否使用HTTPS,默认false

    返回信息

    返回允许/不允许使用HTTPS

  • public boolean isSslRedirects()

    获取sslRedirects的值,取值为true或者false

    返回信息

    返回sslRedirects的值

  • public boolean isTrustCerts()

    获取是否信任所有证书

    返回信息

    返回是否信任所有证书

  • public void setAccessKey(String accessKey)

    设置请求签名的AccessKey。设置了AccessKey和SecretKey的请求将使用AKSK签名算法对请求签名。

    输入参数

    accessKey:请求签名的AccessKey

  • public void setBodyForm(Map<String,String> content)

    设置map类型的HTTP请求内容

    输入参数

    content:HTTP请求内容

  • public void setBodyText(String content)

    设置String类型的HTTP请求内容

    输入参数

    content:HTTP请求内容

  • public void setCaCertData(String caCertData)

    设置ca证书

    输入参数

    caCertData:ca证书

  • public void setCharset(String charset)

    设置HTTP请求编码格式

    输入参数

    charset:HTTP请求编码格式

  • public void setClientCertData(String clientCertData)

    设置客户端证书

    输入参数

    clientCertData:客户端证书

  • public void setClientKeyAlgo(String clientKeyAlgo)

    设置客户端私钥加密算法

    输入参数

    clientKeyAlgo:客户端私钥加密算法

  • public void setClientKeyData(String clientKeyData)

    设置客户端私钥

    输入参数

    clientKeyData:客户端私钥

  • public void setClientKeyPassphrase(String clientKeyPassphrase)

    设置客户端私钥密码

    输入参数

    clientKeyPassphrase:客户端私钥密码

  • public void setConnectionTimeout(int connectionTimeout)

    设置连接超时时间

    输入参数

    connectionTimeout:连接超时时间

  • public void setConnectTimeout(int connectTimeout)

    设置连接超时时间

    输入参数

    connectTimeout:连接超时时间

  • public void setContent(Object content)

    设置String和File类型的HTTP请求内容

    输入参数

    content:HTTP请求内容

  • public void setContentType(String contentType)

    设置HTTP请求内容格式

    输入参数

    contentType:HTTP请求内容格式

  • public void setHeader(String name, String value)

    设置请求头

    输入参数

    • name:请求头名称
    • value:请求头值
  • public void setHeader(String name, String[] value)

    设置请求头

    输入参数

    • name:请求头名称
    • value:请求头值
  • public void setHeaders(Map<String,String> headers)

    设置请求头

    输入参数

    headers:请求头信息

  • public void setHeaderValues(Map<String,String[]> headers)

    设置请求头

    输入参数

    headers:请求头信息

  • public void setHttpProxy(String httpProxy)

    设置http代理

    输入参数

    httpProxy:http代理

  • public void setHttpsProxy(String httpsProxy)

    设置https代理

    输入参数

    httpsProxy:https代理

  • public void setMaxConcurrentRequests(int maxConcurrentRequests)

    设置maxConcurrentRequests

    输入参数

    maxConcurrentRequests:

  • public void setMaxConcurrentRequestsPerHost(int maxConcurrentRequestsPerHost

    设置maxConcurrentRequestsPerHost

    输入参数

    maxConcurrentRequestsPerHost:

  • public void setMethod(String method)

    设置HTTP方法

    输入参数

    method:HTTP方法

  • public void setNoProxy(String[] noProxy)

    设置不使用代理的地址列表

    输入参数

    noProxy:不使用代理的地址列表

  • public void setParameter(String name, String value)

    设置HTTP请求参数

    输入参数

    • name:HTTP请求参数名
    • value:HTTP请求参数值
  • public void setParameters(Map<String,String> parameters)

    设置HTTP请求参数

    输入参数

    parameters:HTTP请求参数

  • public void setProxyPassword(String proxyPassword)

    设置proxy密码

    输入参数

    proxyPassword:proxy密码

  • public void setProxyUsername(String proxyUsername)

    设置proxy用户名

    输入参数

    proxyUsername:proxy用户名

  • public void setRedirects(boolean redirects)

    设置是否允许重定向

    输入参数

    redirects:是否允许重定向

  • public void setRequestId(String requestId)

    设置请求编号

    输入参数

    requestId:请求编号

  • public void setRequestTimeout(int requestTimeout)

    设置请求超时时间

    输入参数

    requestTimeout:请求超时时间

  • public void setRollingTimeout(long rollingTimeout)

    设置rolling超时时间

    输入参数

    rollingTimeout:rolling超时时间

  • public void setScaleTimeout(long scaleTimeout)

    设置scale超时时间

    输入参数

    scaleTimeout:scale超时时间

  • public void setSecretKey(String secretKey)

    设置请求签名的SecretKey。设置了AccessKey和SecretKey的请求将使用AKSK签名算法对请求签名。

    输入参数

    secretKey:请求签名的SecretKey

  • public void setSsl(boolean ssl)

    设置是否使用HTTPS

    输入参数

    ssl:是否使用HTTPS

  • public void setSslRedirects(boolean sslRedirects)

    设置sslRedirects的值,取值为true或者false

    输入参数

    sslRedirects:true或者false

  • public void setTlsVersions(okhttp3.TlsVersion[] tlsVersions)

    设置TLS版本号

    输入参数

    tlsVersions:TLS版本号

  • public void setTrustCerts(boolean trustCerts)

    设置是否信任所有证书

    输入参数

    trustCerts:是否信任所有证书

  • public void setUrl(String url)

    设置Url

    输入参数

    url:URL

  • public void setUserAgent(String userAgent)

    设置userAgent

    输入参数

    userAgent:userAgent值

  • public void setWebsocketPingInterval(long websocketPingInterval)

    设置websocket心跳时间

    输入参数

    websocket心跳时间:

  • public void setWebsocketTimeout(long websocketTimeout)

    设置Websocket超时时间

    输入参数

    websocketTimeout:Websocket超时时间

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区论坛频道来与我们联系探讨

智能客服提问云社区提问