DescribeApi - 查询 API 定义

查询指定API的定义。

接口说明

  • 此接口面向开放API的用户

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeApiRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
GroupIdstring

API所在的分组编号

123
ApiIdstring

API的ID标识

8afff6c8c4c6447abb035812e4d66b65

返回参数

名称类型描述示例值
object
ApiIdstring

API的ID标识

8afff6c8c4c6447abb035812e4d66b65
ResultTypestring

后端服务返回应答的格式,目前可以设置为:JSON、TEXT、BINARY、XML、HTML。

JSON
WebSocketApiTypestring

双向通信API类型:

  • COMMON:普通API
  • REGISTER:注册API
  • UNREGISTER:注销API
  • NOTIFY:下行通知
COMMON
DisableInternetboolean

API是否仅支持内网调用, 取值:

  • true:仅支持内网调用API
  • false:不限制调用
false
ResultBodyModelstring

api的返回结果

{}
ResultSamplestring

后端服务返回应答的示例

200
AppCodeAuthTypestring

AuthTypeAPP认证时,可选值如下:

  • DEFAULT: 不传默认是DEFAULT(随分组设置)
  • DISABLE: 不允许
  • HEADER: 允许AppCode的Header认证
  • HEADER_QUERY: 允许AppCode的Header及Query认证
HEADER
AllowSignatureMethodstring

AuthTypeAPP认证时,需要传该值明确签名算法。可选值如下,不传默认是HmacSHA256:

  • HmacSHA256
  • HmacSHA1,HmacSHA256
HmacSHA256
RegionIdstring

API所处的Region的ID

cn-qingdao
ForceNonceCheckboolean

调用API时是否必须携带header : X-Ca-Nonce, 这个是请求的唯一标识,一般使用UUID来标识。API网关收到这个参数后通过校验这个参数的有效性可以有效防止API的重放攻击,同样的值,15分内只能被使用一次。 取值:

  • true: 请求API时强制检查这个字段,防止API的重放攻击
  • false: 不检查这个字段
true
Visibilitystring

API是否公开,目前可以取值:

  • PUBLIC:公开,如选择此类型,该API的线上环境,会在所有用户的控制台“发现API”页面展示
  • PRIVATE:不公开,如选择此类型,当该组API在云市场上架时,私有类型的API不会上架
PUBLIC
FailResultSamplestring

后端服务失败返回应答的示例

400
AuthTypestring

API安全认证类型,目前可以取值:

  • APP:只允许已授权的APP调用
  • ANONYMOUS:允许匿名调用,设置为允许匿名调用需要注意:
    • 任何能够获取该API服务信息的人,都将能够调用该API。网关不会对调用者做身份认证,也无法设置按用户的流量控制,若开放该API请设置好按API的流量控制。
    • “ANONYMOUS”API不建议上架云市场,网关无法对调用者区分计量,也无法限制调用次数,若所在分组要上架云市场,建议将该API转移至其他分组,或将类型设置为“私有”,或选择“阿里云APP”认证方式。
  • APPOPENID:支持第三方账号认证OpenID Connect,而且只允许已授权的APP调用;当设置此项时,参数OpenIdConnectConfig为必传。
APP
ModifiedTimestring

API最后一次修改的时间

2016-07-28T13:13:12Z
RequestIdstring

请求ID

D0FF585F-7966-40CF-BC60-75DB070B23D5<
Descriptionstring

API描述信息

Api description
GroupNamestring

API所在的分组名称

ApiTest
GroupIdstring

API所在的分组编号

08ae4aa0f95e4321849ee57f4e0b3077
Mockstring

是否启用MOCK模式,目前可以取值:

  • OPEN:启用Mock模式

  • CLOSED:不启用Mock模式

CLOSED
MockResultstring

Mock返回结果

test result
CreatedTimestring

API创建的时间

2016-07-28T09:50:43Z
ApiNamestring

API的名称,组内不允许重复

ApiName
BackendEnableboolean

是否启用后端服务

true
BackendConfigobject

后端配置

BackendIdstring

后端服务ID

0038e00c3dca44fcba3a94015d8f5bbf
BackendTypestring

后端服务类型

HTTP
BackendNamestring

后端服务名称

testoss
RequestConfigobject

Consumer向网关发送API请求的相关配置项

BodyModelstring

body模型

RequestPathstring

API path,比如API的完全地址为http://api.a.com:8080/object/add?key1=value1&key2=value2,path是指/object/add这一部分。

/api/billing/test/[type]
RequestHttpMethodstring

HTTP Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。

POST
BodyFormatstring

RequestMode值为MAPPING时有效。

POST/PUT请求时,表示数据以何种方式传递给服务器,取值为:FORMSTREAM,分别表示表单形式(k-v对应)、字节流形式。

STREAM
RequestModestring

请求的模式,取值为:MAPPINGPASSTHROUGH,分别表示入参映射、入参透传

MAPPING
PostBodyDescriptionstring

Body描述

fwefwef
RequestProtocolstring

API 支持的协议类型,可以多选,多选情况下以英文逗号隔开,如:”HTTP,HTTPS”,取值为:HTTP、HTTPS。

HTTP
ServiceConfigobject

网关向后端服务发送API请求的相关配置项

AoneAppNamestring

aone应用名称

ib-blank
MockStatusCodeinteger

Mock返回状态码

200
ContentTypeValuestring

调用后端服务HTTP服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值。

application/x-www-form-urlencoded; charset=UTF-8
ServiceProtocolstring

后端服务协议类型,目前只支持HTTP/HTTPS

HTTP
ServicePathstring

调用后端服务path,比如后端服务完全地址为http://api.a.com:8080/object/add?key1=value1&key2=value2ServicePath是指/object/add这一部分。

/object/add
ContentTypeCatagorystring

调用后端服务HTTP服务时,ContentType头的取值策略:

  • DEFAULT:使用API网关默认的值
  • CUSTOM:自定义
  • CLIENT:使用客户端上行的ContentType的头
CUSTOM
ServiceAddressstring

调用后端服务地址,比如后端服务完全地址为http://api.a.com:8080/object/add?key1=value1&key2=value2ServiceAddress是指http://api.a.com:8080这一部分。

http://api.a.com:8080
Mockstring

是否采取Mock模式,目前可以取值:

  • TRUE:启用Mock模式
  • FALSE:不启用Mock模式
TRUE
ServiceVpcEnablestring

是否启用VPC通道,目前可以取值:

  • TRUE:启用VPC通道,必须先添加VPC授权成功后才能启用
  • FALSE:不启用VPC通
TRUE
MockResultstring

如果启用Mock模式,返回的结果

test result
ServiceHttpMethodstring

调用后端服务HTTP协议时的Method,取值为:GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。

POST
ServiceTimeoutinteger

后端服务超时时间,单位:毫秒

1000
MockHeadersarray

模拟 Headers

object
HeaderValuestring

HTTP头参数的取值。

86400
HeaderNamestring

HTTP头参数的名字。

Content-Length
VpcConfigobject

VPC通道相关配置项

VpcIdstring

专用网络ID

vpc-2zeafsc3fygk1***
VpcSchemestring

VPC协议

HTTP
InstanceIdstring

专用网络中的实例ID(Ecs/负载均衡)

i-bp1h497hkijewv2***
Portinteger

实例对应的端口号

8080
Namestring

VPC授权名称

glmall-app-test
FunctionComputeConfigobject

后端为函数计算时的后端配置项

FcTypestring

函数计算服务类型

HttpTrigger
RoleArnstring

Ram授权给API网关访问函数计算的arn

acs:ram::111***:role/aliyunserviceroleforsas
Methodstring

请求方法。

GET
FcBaseUrlstring

函数计算服务根路径

https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/
ContentTypeValuestring

调用后端服务函数计算服务,ContentTypeCatagory的值为DEFAULT或者CUSTOM时,ContentType头的取值。

application/x-www-form-urlencoded; charset=UTF-8
RegionIdstring

函数计算所在Region

cn-qingdao
OnlyBusinessPathboolean

后端只接收业务path

false
FunctionNamestring

函数计算定义的FunctionName

edge_function
ContentTypeCatagorystring

调用后端服务函数计算服务时,ContentType头的取值策略:

  • DEFAULT:使用API网关默认的值
  • CUSTOM:自定义
  • CLIENT:使用客户端上行的ContentType的头
DEFAULT
Pathstring

API请求路径

/api/offline/cacheData
ServiceNamestring

函数计算定义的ServiceName

fcservicename
Qualifierstring

函数别名

2
OssConfigobject

后端为OSS的信息

Keystring
Actionstring
OssRegionIdstring

OSS服务所在地域ID。

cn-hangzhou
BucketNamestring

OSS存储Bucket。

cbg-db
EventBridgeConfigobject

事件总线设置

EventBusstring

事件总线

testBus
EventSourcestring

事件来源。

baas_driver
EventBridgeRegionIdstring

事件总线服务所在区域ID

cn-beijing
RoleArnstring

Ram授权给EventBridge的arn

acs:ram::1933122015759***:role/adminoidcaliyun
OpenIdConnectConfigobject

第三方账号认证OpenID Connect相关配置项

OpenIdApiTypestring

OpenID Connect模式,目前可以取值:

  • IDTOKEN:获取授权API,颁发Token,当设置此项时,参数PublicKeyId和PublicKey为必传。
  • BUSINESS:业务API,Token验证,当设置此项时,参数IdTokenParamName为必传。
IDTOKEN
IdTokenParamNamestring

Token对应的参数名称

xxx
PublicKeyIdstring

公钥ID

88483727556929326703309904351185815489
PublicKeystring

公钥

EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92
ErrorCodeSamplesarray

后端服务返回的错误码示例

object
Codestring

错误码

400
Modelstring

模型

[\"*\"]
Messagestring

错误信息

Missing the parameter UserId
Descriptionstring

描述

请求缺少参数 UserId
ResultDescriptionsarray

api的返回说明

object

api的返回说明

Typestring
Keystring
HasChildboolean

是否有子节点。

true
Descriptionstring

描述信息

test
Pidstring

父节点 ID。

pid
Mandatoryboolean

是否必填。

true
Namestring
Idstring

结果 ID。

id
SystemParametersarray

网关发送给后端服务的系统参数

object
DemoValuestring

示例

192.168.1.1
Descriptionstring

参数描述

客户端IP
ParameterNamestring

系统参数名,取值为:CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy。

CaClientIp
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ServiceParameterNamestring

对应后端参数名称

clientIp
CustomSystemParametersarray

自定义系统参数列表

object
DemoValuestring

示例

192.168.1.1
Descriptionstring

参数描述

客户端IP
ParameterNamestring

系统参数名,取值为:CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy

CaClientIp
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ServiceParameterNamestring

对应后端参数名称

clientIp
ConstantParametersarray

网关发送给后端服务的常量参数

object
Descriptionstring

参数描述

constance
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ServiceParameterNamestring

后端参数名称

constance
ConstantValuestring

参数值

constance
RequestParametersarray

Consumer向网关发送API请求的参数描述

object
JsonSchemestring

ParameterType=String,JSON验证(Json Scheme)

JSON
MaxValuelong

ParameterType=Int、Long、Float、Double,参数的最大值限定

123456
ArrayItemsTypestring

数组元素的类型

String
MinValuelong

ParameterType=Int、Long、Float、Double,参数的最小值限定

123456
DocShowstring

文档可见,取值为:PUBLICPRIVATE

PUBLIC
MaxLengthlong

ParameterType=String,参数的最大长度限定

123456
DefaultValuestring

默认值

20
ApiParameterNamestring

参数名

age
EnumValuestring

ParameterType=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F。

boy,girl
DemoValuestring

示例

20
Requiredstring

是否必填,取值为:REQUIREDOPTIONAL,分别表示必填、不必填

OPTIONAL
Descriptionstring

参数描述

年龄
ParameterTypestring

参数类型,取值为:String、Int、Long、Float、Double、Boolean,分别表示字符、整型、长整型、单精度浮点型、双精度浮点型、布尔。

String
RegularExpressionstring

ParameterType=String,参数验证(正则表达式)

xxx
MinLengthlong

ParameterType=String,参数的最小长度限定

123456
DocOrderinteger

文档中顺序

0
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ServiceParametersarray

网关向后端服务发送API请求的参数描述

object
Locationstring

参数位置,取值为:BODY、HEAD、QUERY、PATH

HEAD
ParameterTypestring

后端参数数据类型,取值为:STRING、NUMBER、BOOLEAN,分别表示字符、数值、布尔。

String
ServiceParameterNamestring

后端参数名称

clientIp
ServiceParametersMaparray

Consumer向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系

object
RequestParameterNamestring

对应前端入参名称,这个值必须存在于RequestParametersObject中,匹配于RequestParam.ApiParameterName。

name
ServiceParameterNamestring

后端参数名称

name
DeployedInfosarray

API发布状态

object
StageNamestring

环境名称,取值为:RELEASE、TEST

RELEASE
EffectiveVersionstring

有效的版本

xxx
DeployedStatusstring

部署状态,取值为:DEPLOYED、NONDEPLOYED,分别表示已部署、未部署

DEPLOYED

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 API 网关 相关技术圈