调用DescribeApi查询API定义-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

查询指定API的定义。

接口说明

此接口面向开放 API 的用户

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DescribeApi

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	否	API 所在的分组编号	123
ApiId	string	是	API 的 ID 标识	8afff6c8c4c6447abb035812e4d66b65

返回参数

名称	类型	描述	示例值
	object
ApiId	string	API 的 ID 标识	8afff6c8c4c6447abb035812e4d66b65
ResultType	string	后端服务返回应答的格式，目前可以设置为：JSON、TEXT、BINARY、XML、HTML。	JSON
WebSocketApiType	string	双向通信 API 类型： COMMON：普通 API REGISTER：注册 API UNREGISTER：注销 API NOTIFY：下行通知	COMMON
DisableInternet	boolean	API 是否仅支持内网调用, 取值： true：仅支持内网调用 API false：不限制调用	false
ResultBodyModel	string	api 的返回结果	{}
ResultSample	string	后端服务返回应答的示例	200
AppCodeAuthType	string	当 AuthType 为 APP 认证时，可选值如下： DEFAULT: 不传默认是 DEFAULT(随分组设置) DISABLE: 不允许 HEADER: 允许 AppCode 的 Header 认证 HEADER_QUERY: 允许 AppCode 的 Header 及 Query 认证	HEADER
AllowSignatureMethod	string	当 AuthType 为 APP 认证时，需要传该值明确签名算法。可选值如下，不传默认是 HmacSHA256： HmacSHA256 HmacSHA1,HmacSHA256	HmacSHA256
RegionId	string	API 所处的 Region 的 ID	cn-qingdao
ForceNonceCheck	boolean	调用 API 时是否必须携带 header : X-Ca-Nonce, 这个是请求的唯一标识，一般使用 UUID 来标识。API 网关收到这个参数后通过校验这个参数的有效性可以有效防止 API 的重放攻击，同样的值，15 分内只能被使用一次。取值： true: 请求 API 时强制检查这个字段，防止 API 的重放攻击 false: 不检查这个字段	true
Visibility	string	API 是否公开，目前可以取值： PUBLIC：公开，如选择此类型，该 API 的线上环境，会在所有用户的控制台“发现 API”页面展示 PRIVATE：不公开，如选择此类型，当该组 API 在云市场上架时，私有类型的 API 不会上架	PUBLIC
FailResultSample	string	后端服务失败返回应答的示例	400
AuthType	string	API 安全认证类型，目前可以取值： APP：只允许已授权的 APP 调用 ANONYMOUS：允许匿名调用，设置为允许匿名调用需要注意：任何能够获取该 API 服务信息的人，都将能够调用该 API。网关不会对调用者做身份认证，也无法设置按用户的流量控制，若开放该 API 请设置好按 API 的流量控制。 “ANONYMOUS”API 不建议上架云市场，网关无法对调用者区分计量，也无法限制调用次数，若所在分组要上架云市场，建议将该 API 转移至其他分组，或将类型设置为“私有”，或选择“阿里云 APP”认证方式。 APPOPENID：支持第三方账号认证 OpenID Connect，而且只允许已授权的 APP 调用；当设置此项时，参数 OpenIdConnectConfig 为必传。	APP
ModifiedTime	string	API 最后一次修改的时间	2016-07-28T13:13:12Z
RequestId	string	请求 ID	D0FF585F-7966-40CF-BC60-75DB070B23D5<
Description	string	API 描述信息	Api description
GroupName	string	API 所在的分组名称	ApiTest
GroupId	string	API 所在的分组编号	08ae4aa0f95e4321849ee57f4e0b3077
Mock	string	是否启用 MOCK 模式，目前可以取值： OPEN：启用 Mock 模式 CLOSED：不启用 Mock 模式	CLOSED
MockResult	string	Mock 返回结果	test result
CreatedTime	string	API 创建的时间	2016-07-28T09:50:43Z
ApiName	string	API 的名称，组内不允许重复	ApiName
BackendEnable	boolean	是否启用后端服务	true
BackendConfig	object	后端配置
BackendId	string	后端服务 ID	0038e00c3dca44fcba3a94015d8f5bbf
BackendType	string	后端服务类型	HTTP
BackendName	string	后端服务名称	testoss
RequestConfig	object	Consumer 向网关发送 API 请求的相关配置项
BodyModel	string	body 模型	https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab
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、PASSTHROUGH，分别表示入参映射、入参透传	MAPPING
PostBodyDescription	string	Body 描述	fwefwef
RequestProtocol	string	API 支持的协议类型，可以多选，多选情况下以英文逗号隔开，如：”HTTP,HTTPS”，取值为：HTTP、HTTPS。	HTTP
EscapePathParam	boolean	是否转义 Path 参数，如果为 true，则 Path 上的[param]将被视为普通字符。	true
ServiceConfig	object	网关向后端服务发送 API 请求的相关配置项
AoneAppName	string	aone 应用名称	ib-blank
MockStatusCode	integer	Mock 返回状态码	200
ContentTypeValue	string	调用后端服务 HTTP 服务，ContentTypeCatagory 的值为 DEFAULT 或者 CUSTOM 时，ContentType 头的取值。	application/x-www-form-urlencoded; charset=UTF-8
ServiceProtocol	string	后端服务协议类型，目前只支持 HTTP/HTTPS	HTTP
ServicePath	string	调用后端服务 path，比如后端服务完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`，ServicePath 是指`/object/add`这一部分。	/object/add
ContentTypeCatagory	string	调用后端服务 HTTP 服务时，ContentType 头的取值策略： DEFAULT：使用 API 网关默认的值 CUSTOM：自定义 CLIENT：使用客户端上行的 ContentType 的头	CUSTOM
ServiceAddress	string	调用后端服务地址，比如后端服务完全地址为`http://api.a.com:8080/object/add?key1=value1&key2=value2`，ServiceAddress 是指`http://api.a.com:8080`这一部分。	http://api.a.com:8080
Mock	string	是否采取 Mock 模式，目前可以取值： TRUE：启用 Mock 模式 FALSE：不启用 Mock 模式	TRUE
ServiceVpcEnable	string	是否启用 VPC 通道，目前可以取值： TRUE：启用 VPC 通道，必须先添加 VPC 授权成功后才能启用 FALSE：不启用 VPC 通	TRUE
MockResult	string	如果启用 Mock 模式，返回的结果	test result
ServiceHttpMethod	string	调用后端服务 HTTP 协议时的 Method，取值为：GET、POST、DELETE、PUT、HEADER、TRACE、PATCH、CONNECT、OPTIONS。	POST
ServiceTimeout	integer	后端服务超时时间，单位：毫秒	1000
MockHeaders	object
MockHeader	array<object>	模拟 Headers
	object
HeaderValue	string	HTTP 头参数的取值。	86400
HeaderName	string	HTTP 头参数的名字。	Content-Length
VpcConfig	object	VPC 通道相关配置项
VpcId	string	专用网络 ID	vpc-2zeafsc3fygk1***
VpcScheme	string	VPC 协议	HTTP
InstanceId	string	专用网络中的实例 ID（Ecs/负载均衡）	i-bp1h497hkijewv2***
Port	integer	实例对应的端口号	8080
Name	string	VPC 授权名称	glmall-app-test
FunctionComputeConfig	object	后端为函数计算时的后端配置项
FcType	string	函数计算服务类型	HttpTrigger
RoleArn	string	Ram 授权给 API 网关访问函数计算的 arn	acs:ram::111***:role/aliyunserviceroleforsas
Method	string	请求方法。	GET
FcBaseUrl	string	函数计算服务根路径	https://1227**64334133.ap-southeast-1-intal.fc.aliyuncs.com/201*-15/proxy/test**ice.LATEST/testHttp/
ContentTypeValue	string	调用后端服务函数计算服务，ContentTypeCatagory 的值为 DEFAULT 或者 CUSTOM 时，ContentType 头的取值。	application/x-www-form-urlencoded; charset=UTF-8
RegionId	string	函数计算所在 Region	cn-qingdao
OnlyBusinessPath	boolean	后端只接收业务 path	false
FunctionName	string	函数计算定义的 FunctionName	edge_function
ContentTypeCatagory	string	调用后端服务函数计算服务时，ContentType 头的取值策略： DEFAULT：使用 API 网关默认的值 CUSTOM：自定义 CLIENT：使用客户端上行的 ContentType 的头	DEFAULT
Path	string	API 请求路径	/api/offline/cacheData
ServiceName	string	函数计算定义的 ServiceName	fcservicename
Qualifier	string	函数别名	2
TriggerName	string
FcVersion	string
OssConfig	object	后端为 OSS 的信息
Key	string	OSS 内存储对象或文件夹路径	/folder/test.json
Action	string	OSS 的操作，目前可以取值 GetObject PostObject DeleteObject PutObject HeadObject GetObjectMeta AppendObject	GetObject
OssRegionId	string	OSS 服务所在地域 ID。	cn-hangzhou
BucketName	string	OSS 存储 Bucket。	cbg-db
EventBridgeConfig	object	事件总线设置
EventBus	string	事件总线	testBus
EventSource	string	事件来源。	baas_driver
EventBridgeRegionId	string	事件总线服务所在区域 ID	cn-beijing
RoleArn	string	Ram 授权给 EventBridge 的 arn	acs:ram::1933122015759***:role/adminoidcaliyun
OpenIdConnectConfig	object	第三方账号认证 OpenID Connect 相关配置项
OpenIdApiType	string	OpenID Connect 模式，目前可以取值： IDTOKEN：获取授权 API，颁发 Token，当设置此项时，参数 PublicKeyId 和 PublicKey 为必传。 BUSINESS：业务 API，Token 验证，当设置此项时，参数 IdTokenParamName 为必传。	IDTOKEN
IdTokenParamName	string	Token 对应的参数名称	xxx
PublicKeyId	string	公钥 ID	88483727556929326703309904351185815489
PublicKey	string	公钥	EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92
ErrorCodeSamples	object
ErrorCodeSample	array<object>	后端服务返回的错误码示例
	object
Code	string	错误码	400
Model	string	模型	[\"*\"]
Message	string	错误信息	Missing the parameter UserId
Description	string	描述	请求缺少参数 UserId
SystemParameters	object
SystemParameter	array<object>	网关发送给后端服务的系统参数
	object
DemoValue	string	示例	192.168.1.1
Description	string	参数描述	客户端IP
ParameterName	string	系统参数名，取值为：CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy。	CaClientIp
Location	string	参数位置，取值为：BODY、HEAD、QUERY、PATH	HEAD
ServiceParameterName	string	对应后端参数名称	clientIp
CustomSystemParameters	object
CustomSystemParameter	array<object>	自定义系统参数列表
	object
DemoValue	string	示例	192.168.1.1
Description	string	参数描述	客户端IP
ParameterName	string	系统参数名，取值为：CaClientIp、CaDomain、CaRequestHandleTime、CaAppId、CaRequestId、CaHttpSchema、CaProxy	CaClientIp
Location	string	参数位置，取值为：BODY、HEAD、QUERY、PATH	HEAD
ServiceParameterName	string	对应后端参数名称	clientIp
ConstantParameters	object
ConstantParameter	array<object>	网关发送给后端服务的常量参数
	object
Description	string	参数描述	constance
Location	string	参数位置，取值为：BODY、HEAD、QUERY、PATH	HEAD
ServiceParameterName	string	后端参数名称	constance
ConstantValue	string	参数值	constance
RequestParameters	object
RequestParameter	array<object>	Consumer 向网关发送 API 请求的参数描述
	object
JsonScheme	string	当 ParameterType=String，JSON 验证(Json Scheme)	JSON
MaxValue	integer	当 ParameterType=Int、Long、Float、Double，参数的最大值限定	123456
ArrayItemsType	string	数组元素的类型	String
MinValue	integer	当 ParameterType=Int、Long、Float、Double，参数的最小值限定	123456
DocShow	string	文档可见，取值为：PUBLIC、PRIVATE	PUBLIC
MaxLength	integer	当 ParameterType=String，参数的最大长度限定	123456
DefaultValue	string	默认值	20
ApiParameterName	string	参数名	age
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	是否必填，取值为：REQUIRED、OPTIONAL，分别表示必填、不必填	OPTIONAL
Description	string	参数描述	年龄
ParameterType	string	参数类型，取值为：String、Int、Long、Float、Double、Boolean，分别表示字符、整型、长整型、单精度浮点型、双精度浮点型、布尔。	String
RegularExpression	string	当 ParameterType=String，参数验证（正则表达式）	xxx
MinLength	integer	当 ParameterType=String，参数的最小长度限定	123456
DocOrder	integer	文档中顺序	0
Location	string	参数位置，取值为：BODY、HEAD、QUERY、PATH	HEAD
ServiceParameters	object
ServiceParameter	array<object>	网关向后端服务发送 API 请求的参数描述
	object
Location	string	参数位置，取值为：BODY、HEAD、QUERY、PATH	HEAD
ParameterType	string	后端参数数据类型，取值为：STRING、NUMBER、BOOLEAN，分别表示字符、数值、布尔。	String
ServiceParameterName	string	后端参数名称	clientIp
ServiceParametersMap	object
ServiceParameterMap	array<object>	Consumer 向网关发送请求的参数和网关向后端服务发送的请求的参数的映射关系
	object
RequestParameterName	string	对应前端入参名称，这个值必须存在于 RequestParametersObject 中，匹配于 RequestParam.ApiParameterName。	name
ServiceParameterName	string	后端参数名称	name
DeployedInfos	object
DeployedInfo	array<object>	API 发布状态
	object
StageName	string	环境名称，取值为：RELEASE、TEST	RELEASE
EffectiveVersion	string	有效的版本	xxx
DeployedStatus	string	部署状态，取值为：DEPLOYED、NONDEPLOYED，分别表示已部署、未部署	DEPLOYED
TagList	object
Tag	array<object>	标签列表
	object
TagKey	string	标签键	APP
TagValue	string	标签值	value3

示例

正常返回示例

JSON格式

{
  "ApiId": "8afff6c8c4c6447abb035812e4d66b65",
  "ResultType": "JSON",
  "WebSocketApiType": "COMMON",
  "DisableInternet": false,
  "ResultBodyModel": "{}",
  "ResultSample": "200",
  "AppCodeAuthType": "HEADER",
  "AllowSignatureMethod": "HmacSHA256",
  "RegionId": "cn-qingdao",
  "ForceNonceCheck": true,
  "Visibility": "PUBLIC",
  "FailResultSample": "400",
  "AuthType": "APP",
  "ModifiedTime": "2016-07-28T13:13:12Z",
  "RequestId": "D0FF585F-7966-40CF-BC60-75DB070B23D5<",
  "Description": "Api description",
  "GroupName": "ApiTest",
  "GroupId": "08ae4aa0f95e4321849ee57f4e0b3077",
  "Mock": "CLOSED",
  "MockResult": "test result",
  "CreatedTime": "2016-07-28T09:50:43Z",
  "ApiName": "ApiName",
  "BackendEnable": true,
  "BackendConfig": {
    "BackendId": "0038e00c3dca44fcba3a94015d8f5bbf",
    "BackendType": "HTTP",
    "BackendName": "testoss"
  },
  "RequestConfig": {
    "BodyModel": "https://apigateway.aliyun.com/models/3a240a127dcc4afd9ab1bf7e947b4095/9e2df550e85b4121a79ec33e2619eaab",
    "RequestPath": "/api/billing/test/[type]",
    "RequestHttpMethod": "POST",
    "BodyFormat": "STREAM",
    "RequestMode": "MAPPING",
    "PostBodyDescription": "fwefwef",
    "RequestProtocol": "HTTP",
    "EscapePathParam": true
  },
  "ServiceConfig": {
    "AoneAppName": "ib-blank",
    "MockStatusCode": 200,
    "ContentTypeValue": "application/x-www-form-urlencoded; charset=UTF-8",
    "ServiceProtocol": "HTTP",
    "ServicePath": "/object/add",
    "ContentTypeCatagory": "CUSTOM",
    "ServiceAddress": "http://api.a.com:8080",
    "Mock": "TRUE",
    "ServiceVpcEnable": "TRUE",
    "MockResult": "test result",
    "ServiceHttpMethod": "POST",
    "ServiceTimeout": 1000,
    "MockHeaders": {
      "MockHeader": [
        {
          "HeaderValue": "86400",
          "HeaderName": "Content-Length"
        }
      ]
    },
    "VpcConfig": {
      "VpcId": "vpc-2zeafsc3fygk1***",
      "VpcScheme": "HTTP",
      "InstanceId": "i-bp1h497hkijewv2***",
      "Port": 8080,
      "Name": "glmall-app-test"
    },
    "FunctionComputeConfig": {
      "FcType": "HttpTrigger",
      "RoleArn": "acs:ram::111***:role/aliyunserviceroleforsas",
      "Method": "GET",
      "FcBaseUrl": "https://1227****64334133.ap-southeast-1-int***al.fc.aliyuncs.com/201****-15/proxy/test****ice.LATEST/testHttp/",
      "ContentTypeValue": "application/x-www-form-urlencoded; charset=UTF-8",
      "RegionId": "cn-qingdao",
      "OnlyBusinessPath": false,
      "FunctionName": "edge_function",
      "ContentTypeCatagory": "DEFAULT",
      "Path": "/api/offline/cacheData",
      "ServiceName": "fcservicename",
      "Qualifier": "2",
      "TriggerName": "",
      "FcVersion": ""
    },
    "OssConfig": {
      "Key": "/folder/test.json",
      "Action": "GetObject",
      "OssRegionId": "cn-hangzhou",
      "BucketName": "cbg-db"
    },
    "EventBridgeConfig": {
      "EventBus": "testBus",
      "EventSource": "baas_driver",
      "EventBridgeRegionId": "cn-beijing",
      "RoleArn": "acs:ram::1933122015759***:role/adminoidcaliyun"
    }
  },
  "OpenIdConnectConfig": {
    "OpenIdApiType": "IDTOKEN",
    "IdTokenParamName": "xxx",
    "PublicKeyId": "88483727556929326703309904351185815489",
    "PublicKey": "EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92"
  },
  "ErrorCodeSamples": {
    "ErrorCodeSample": [
      {
        "Code": "400",
        "Model": "[\\\"*\\\"]",
        "Message": "Missing the parameter UserId",
        "Description": "请求缺少参数 UserId"
      }
    ]
  },
  "SystemParameters": {
    "SystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "客户端IP",
        "ParameterName": "CaClientIp",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "CustomSystemParameters": {
    "CustomSystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "客户端IP",
        "ParameterName": "CaClientIp",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ConstantParameters": {
    "ConstantParameter": [
      {
        "Description": "constance",
        "Location": "HEAD",
        "ServiceParameterName": "constance",
        "ConstantValue": "constance"
      }
    ]
  },
  "RequestParameters": {
    "RequestParameter": [
      {
        "JsonScheme": "JSON",
        "MaxValue": 123456,
        "ArrayItemsType": "String",
        "MinValue": 123456,
        "DocShow": "PUBLIC",
        "MaxLength": 123456,
        "DefaultValue": "20",
        "ApiParameterName": "age",
        "EnumValue": "boy,girl",
        "DemoValue": "20",
        "Required": "OPTIONAL",
        "Description": "年龄",
        "ParameterType": "String",
        "RegularExpression": "xxx",
        "MinLength": 123456,
        "DocOrder": 0,
        "Location": "HEAD"
      }
    ]
  },
  "ServiceParameters": {
    "ServiceParameter": [
      {
        "Location": "HEAD",
        "ParameterType": "String",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ServiceParametersMap": {
    "ServiceParameterMap": [
      {
        "RequestParameterName": "name",
        "ServiceParameterName": "name"
      }
    ]
  },
  "DeployedInfos": {
    "DeployedInfo": [
      {
        "StageName": "RELEASE",
        "EffectiveVersion": "xxx",
        "DeployedStatus": "DEPLOYED"
      }
    ]
  },
  "TagList": {
    "Tag": [
      {
        "TagKey": "APP",
        "TagValue": "value3"
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。