| object | | |
ApiId | string | | b24be7e59a104e52bffbf432cc9272af |
ResultType | string | | JSON |
DisableInternet | boolean | - 设置DisableInternet为true, 仅支持内网调用API。
- 设置DisableInternet为false, 则不限制调用。创建API时默认为false。
| true |
ResultSample | string | | {\n \"status\": 0,\n \"data\": {\n \"count\": 1,\n \"list\": [\n \"352\"\n ]\n },\n \"message\": \"success\"\n} |
RegionId | string | | cn-hangzhou |
ForceNonceCheck | boolean | 设置ForceNonceCheck为true, 请求时强制检查X-Ca-Nonce,这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后会校验这个参数的有效性,同样的值,15分内只能被使用一次。可以有效防止API的重放攻击。 设置ForceNonceCheck为false,则不检查。创建API时默认为false。
| true |
Visibility | string | 可见性,取值为:PUBLIC、PRIVATE,分别表示公开、私有 | PUBLIC |
FailResultSample | string | | {"errorCode":"fail","errorMessage":"param invalid"} |
AuthType | string | 安全认证方式,取值为:APP、ANONYMOUS,分别表示阿里云APP、匿名 | APP |
RequestId | string | | F253FB5F-9AE1-5DDA-99B5-46BE00A3719E |
GroupId | string | | f51d08c5b7c84342905544ebaec26d35 |
GroupName | string | | 会员时代交易服务 |
Description | string | | 领克数字商城OMS-UAT |
DeployedTime | string | | 2022-07-13T16:00:33Z |
StageName | string | | RELEASE |
ApiName | string | | 获取关键词二维码地址 |
RequestConfig | object | 由 RequestConfig 组成的格式,返回API前端定义信息 | |
RequestPath | string | API path,比如API的完全地址为http://api.a.com:8080/object/add?key1=value1&key2=value2 ,path是指/object/add 这一部分。 | /api/billing/test/[type] |
RequestHttpMethod | string | HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。 | POST |
BodyFormat | string | 当RequestMode值为MAPPING时有效。 POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:FORM、STREAM,分别表示表单形式(k-v对应)、字节流形式。 | STREAM |
RequestMode | string | | MAPPING |
PostBodyDescription | string | | fwefwef |
RequestProtocol | string | API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:”HTTP,HTTPS”,取值为:HTTP、HTTPS。 | HTTP |
ErrorCodeSamples | array | | |
| object | | |
Code | string | | Error |
Message | string | | error message |
Description | string | | 未授权 |
ResultDescriptions | array | | |
| object | | |
Type | string | | |
Key | string | | |
HasChild | boolean | | |
Description | string | | Api description |
Pid | string | | |
Mandatory | boolean | | true |
Name | string | | |
Id | string | | |
RequestParameters | array | 由 RequestParameter 组成的数组格式,返回API中前端入参信息项 | |
| object | 由 RequestParameter 组成的数组格式,返回API中前端入参信息项 | |
JsonScheme | string | | {} |
MaxValue | long | | 200 |
ArrayItemsType | string | | String |
MinValue | long | | 123456 |
DocShow | string | | PUBLIC |
MaxLength | long | | 123456 |
DefaultValue | string | | 20 |
ApiParameterName | string | | Length |
EnumValue | string | 当ParameterType=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F。 | boy,girl |
DemoValue | string | | 20 |
Required | string | | OPTIONAL |
Description | string | | 参数说明 |
ParameterType | string | | String |
RegularExpression | string | 当ParameterType=String,参数验证(正则表达式) | xxx |
MinLength | long | | 2 |
DocOrder | integer | | 0 |
Location | string | 参数位置,取值为:BODY、HEAD、QUERY、PATH | HEAD |