DescribeDeployedApi - API Gateway - Alibaba Cloud Documentation Center

Queries the definition of an API that takes effect in an environment. The definition may differ from the definition being edited.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the API group. This ID is generated by the system and globally unique.	81750604ccff48c48f34d6c0165e09db
ApiId	string	Yes	The ID of the API.	ab7c95a01a7e42f28718f34497bbf47c
StageName	string	Yes	The name of the runtime environment. Valid values: RELEASE PRE: the pre-release environment TEST	RELEASE

Response parameters

Parameter	Type	Description	Example
	object
ApiId	string	The ID of the API.	4eed13a57d4e42fbb51316be8a5329ff
ResultType	string	The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON.	HTML
DisableInternet	boolean	Specifies whether to set DisableInternet to true to limit API calls to within the VPC. If you set DisableInternet to false, the limit is lifted. Note If you do not set this parameter, the original value is not modified.	true
ResultBodyModel	string	The return description of the API.	{}
ResultSample	string	The sample response from the backend service.	{code: 200, message:'success', data: ''}
AllowSignatureMethod	string	The signature method used by the client. Valid values: HmacSHA256 HmacSHA1,HmacSHA256	HmacSHA256
RegionId	string	The region to which the API group belongs.	cn-beijing
ForceNonceCheck	boolean	Specifies whether to set ForceNonceCheck to true to force the check of X-Ca-Nonce during the request. This is the unique identifier of the request and is generally identified by UUID. After receiving this parameter, API Gateway verifies the validity of this parameter. The same value can be used only once within 15 minutes. This helps prevent replay attacks. If you set ForceNonceCheck to false, the check is not performed. The default value is false when you create an API.	true
Visibility	string	Specifies whether to make the API public. Valid values: PUBLIC: Make the API public. If you set this parameter to PUBLIC, this API is displayed on the APIs page for all users after the API is published to the production environment. PRIVATE**: Make the API private. Private APIs are not displayed in the Alibaba Cloud Marketplace after the API group to which they belong is made available.	PUBLIC
FailResultSample	string	The sample error response from the backend service.	{"errorCode":"fail","errorMessage":"param invalid"}
AuthType	string	The security authentication method of the API. Valid values: APP: Only authorized applications can call the API. ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules: All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.	APP
RequestId	string	The ID of the request.	EF924FE4-2EDD-4CD3-89EC-34E4708574E7
Description	string	The description.	Api description
GroupName	string	The name of the API group.	Weather
GroupId	string	The ID of the API group.	bc77f5b49c974437a9912ea3755cd834
DeployedTime	string	The deployment time. Format: yyyy-mm-ddhh:mm:ss.	2022-07-25T17:47:51Z
StageName	string	The name of the runtime environment. Valid values: RELEASE PRE: the pre-release environment TEST	RELEASE
ApiName	string	The name of the API	weather
RequestConfig	object	Configuration items of API requests sent by the consumer to API Gateway. For more information, see RequestConfig .
BodyModel	string	The body model.	https://apigateway.aliyun.com/models/3a240a127dccXXXXXXXX947b4095/9e2df550e85b4121a79XXXXXxaab
RequestPath	string	The API request path. If the complete API URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the API request path is `/object/add` .	/api/billing/test/[type]
RequestHttpMethod	string	The HTTP method used to make the request. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.	POST
BodyFormat	string	This parameter takes effect only when the RequestMode parameter is set to MAPPING. The server data transmission method used for POST and PUT requests. Valid values: FORM and STREAM. FORM indicates that data in key-value pairs is transmitted as forms. STREAM indicates that data is transmitted as byte streams.	STREAM
RequestMode	string	The request mode. Valid values: MAPPING: Parameters are mapped. Unknown parameters are filtered out. PASSTHROUGH: Parameters are passed through. MAPPING_PASSTHROUGH: Parameters are mapped. Unknown parameters are passed through.	MAPPING
PostBodyDescription	string	The description of the request body.	fwefwef
RequestProtocol	string	The protocol type supported by the API. Valid values: HTTP, HTTPS, and WebSocket. Separate multiple values with commas (,), such as "HTTP,HTTPS".	HTTP
ServiceConfig	object	The configuration items of API requests sent by API Gateway to the backend service. For more information, see ServiceConfig .
VpcId	string	The ID of the VPC.	vpc-uf6kg9x8sx2tbxxxx
MockStatusCode	integer	The status code returned for service mocking.	200
ServicePath	string	The path used to call the back-end service. If the complete back-end service path is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, ServicePath is /object/add.``	/object/add
Mock	string	Specifies whether to enable the Mock mode. Valid values: TRUE: The Mock mode is enabled. **FALSE: The Mock mode is not enabled.	TRUE
ServiceAddress	string	The URL used to call the back-end service. If the complete back-end service URL is `http://api.a.com:8080/object/add?key1=value1&key2=value2`, the value of ServiceAddress is http://api.a.com:8080.``	http://api.a.com:8080
ServiceVpcEnable	string	Specifies whether to enable the VPC channel. Valid values: TRUE: The VPC channel is enabled. You must create the corresponding VPC access authorization before you can enable a VPC channel. FALSE: The VPC channel is not enabled.	TRUE
MockResult	string	The result returned when the Mock mode is enabled.	test result
ServiceHttpMethod	string	The HTTP method used to call a backend service. Valid values: GET, POST, DELETE, PUT, HEADER, TRACE, PATCH, CONNECT, and OPTIONS.	POST
ServiceProtocol	string	The backend service protocol. Currently, only HTTP, HTTPS, and FunctionCompute are supported.	HTTP
ServiceTimeout	integer	The timeout period of the backend service, in millisecond.	1000
MockHeaders	array<object>	The simulated Headers.
MockHeader	object
HeaderValue	string	The value of the HTTP header parameter.	86400
HeaderName	string	The name of the HTTP header parameter.	Content-Type
VpcConfig	object	Configuration items related to VPC channels
VpcId	string	The ID of the VPC.	vpc-2zeafsc3fygk1***
InstanceId	string	The IDs of the ELB and SLB instances in the VPC.	i-bp1h497hkijewv2***
Port	integer	The port number that corresponds to the instance.	8080
Name	string	The name of the VPC access authorization.	glmall-app-test
FunctionComputeConfig	object	Backend configuration items when the backend service is Function Compute
FcType	string	The type of the Function Compute instance.	HttpTrigger
RoleArn	string	The Alibaba Cloud Resource Name (ARN) of the RAM role to be assumed by API Gateway to access Function Compute.	acs:ram::111***:role/aliyunserviceroleforsas
Method	string	The request method.	GET
FcBaseUrl	string	The root path of Function Compute.	https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/
ContentTypeValue	string	The value of the ContentType header when the ServiceProtocol parameter is set to HTTP and the ContentTypeCatagory parameter is set to DEFAULT or CUSTOM.	application/x-www-form-urlencoded; charset=UTF-8
RegionId	string	The region where the API is located.	cn-beijing
OnlyBusinessPath	boolean	The backend only receives the service path.	false
FunctionName	string	The function name defined in Function Compute.	domain_business_control
ContentTypeCatagory	string	The ContentType header type used when you call the backend service over HTTP. DEFAULT: the default header type in API Gateway. CUSTOM: a custom header type. **CLIENT: the ContentType header type of the client.	DEFAULT
Path	string	The API request path.	/api/offline/cacheData
ServiceName	string	The service name defined in Function Compute.	fcservicename
Qualifier	string	The alias of the function.	2
OpenIdConnectConfig	object	The configuration items of the third-party OpenID Connect authentication method.
OpenIdApiType	string	The configuration of OpenID Connect authentication. Valid values: IDTOKEN: indicates the APIs that are called by clients to obtain tokens. If you specify this value, the PublicKeyId parameter and the PublicKey parameter are required. **BUSINESS: indicates business APIs. Tokens are used to call the business APIs. If you specify this value, the IdTokenParamName parameter is required.	IDTOKEN
IdTokenParamName	string	The name of the parameter that corresponds to the token.	xxx
PublicKeyId	string	The ID of the public key.	88483727556929326703309904351185815489
PublicKey	string	The public key of the API.	EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92
ErrorCodeSamples	array<object>	The sample error codes returned by the backend service. For more information, see ErrorCodeSample .
ErrorCodeSample	object
Code	string	The error code.	Error
Message	string	The error message.	error message
Description	string	The description.	Description
ResultDescriptions	array<object>	The return description of the API.
ResultDescription	object	The return description of the API.
Type	string	The type of the result.	String
Key	string	The primary key of the result.	DEMO
HasChild	boolean	Specifies whether a subnode exists.	false
Description	string	The description.	result description
Pid	string	The ID of the parent node.	pid
Mandatory	boolean	Specifies whether the parameter is required.	true
Name	string	The name of the result.	fwqf
Id	string	The ID of the result.	id
SystemParameters	array<object>	System parameters
SystemParameter	object
DemoValue	string	Examples	192.168.1.1
Description	string	The description.	QueryParamDTO
ParameterName	string	The name of the system parameter. Valid values: CaClientIp, CaDomain, CaRequestHandleTime, CaAppId, CaRequestId, CaHttpSchema, and CaProxy.	CaClientIp
Location	string	The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.	HEAD
ServiceParameterName	string	The name of the corresponding backend parameter.	clientIp
CustomSystemParameters	array<object>	The custom system parameters.
CustomSystemParameter	object
DemoValue	string	Example	192.168.1.1
Description	string	The description.	123
ParameterName	string	The name of the custom system parameter.	appid
Location	string	The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.	HEAD
ServiceParameterName	string	The name of the corresponding backend parameter.	clientIp
ConstantParameters	array<object>	The constant parameters.
ConstantParameter	object
Description	string	The description.	123
Location	string	The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.	HEAD
ServiceParameterName	string	The name of the backend service parameter.	constance
ConstantValue	string	The constant value.	constance
RequestParameters	array<object>	The parameters of API requests sent by the consumer to API Gateway. For more information, see RequestParameter .
RequestParameter	object
JsonScheme	string	JSON scheme	{}
MaxValue	long	The maximum parameter value when ParameterType is set to Int, Long, Float, or Double.	123456
ArrayItemsType	string	The type of the array element.	String
MinValue	long	The minimum parameter value when ParameterType is set to Int, Long, Float, or Double.	123456
DocShow	string	Specifies whether the document is public. Valid values: PUBLIC and PRIVATE.	PUBLIC
MaxLength	long	The maximum parameter length when ParameterType is set to String.	123456
DefaultValue	string	The default value.	20
ApiParameterName	string	The name of the API parameter.	age
EnumValue	string	The hash values that can be entered when ParameterType is set to Int, Long, Float, Double, or String. Separate different values with commas (,), such as 1,2,3,4,9 or A,B,C,E,F.	boy,girl
DemoValue	string	Example	20
Required	string	Indicates whether the parameter is required. Valid values: REQUIRED and OPTIONAL.	OPTIONAL
Description	string	Description	parameter description
ParameterType	string	The type of a request parameter. Valid values: String, Int, Long, Float, Double, and Boolean.	String
RegularExpression	string	The regular expression used for parameter validation when ParameterType is set to String.	xxx
MinLength	long	The minimum parameter length when ParameterType is set to String.	123456
DocOrder	integer	The order in the document.	0
Location	string	The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.	HEAD
ServiceParameters	array<object>	The parameters of API requests sent by API Gateway to the backend service. For more information, see ServiceParameter .
ServiceParameter	object
Location	string	The parameter location. Valid values: BODY, HEAD, QUERY, and PATH.	HEAD
ParameterType	string	The data type of the back-end service parameter.	String
ServiceParameterName	string	The name of the backend service parameter.	clientIp
ServiceParametersMap	array<object>	The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service. For more information, see ServiceParameterMap .
ServiceParameterMap	object
RequestParameterName	string	The name of the front-end input parameter.	sex
ServiceParameterName	string	The name of the backend service parameter.	sex

Examples

Sample success responses

JSONformat

{
  "ApiId": "4eed13a57d4e42fbb51316be8a5329ff",
  "ResultType": "HTML",
  "DisableInternet": true,
  "ResultBodyModel": {},
  "ResultSample": "{code: 200, message:'success', data: ''}",
  "AllowSignatureMethod": "HmacSHA256",
  "RegionId": "cn-beijing",
  "ForceNonceCheck": true,
  "Visibility": "PUBLIC",
  "FailResultSample": {
    "errorCode": "fail",
    "errorMessage": "param invalid"
  },
  "AuthType": "APP",
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7",
  "Description": "Api description",
  "GroupName": "Weather",
  "GroupId": "bc77f5b49c974437a9912ea3755cd834",
  "DeployedTime": "2022-07-25T17:47:51Z",
  "StageName": "RELEASE",
  "ApiName": "weather",
  "RequestConfig": {
    "BodyModel": "https://apigateway.aliyun.com/models/3a240a127dccXXXXXXXX947b4095/9e2df550e85b4121a79XXXXXxaab",
    "RequestPath": "/api/billing/test/[type]",
    "RequestHttpMethod": "POST",
    "BodyFormat": "STREAM",
    "RequestMode": "MAPPING",
    "PostBodyDescription": "fwefwef",
    "RequestProtocol": "HTTP"
  },
  "ServiceConfig": {
    "VpcId": "vpc-uf6kg9x8sx2tbxxxx",
    "MockStatusCode": 200,
    "ServicePath": "/object/add",
    "Mock": "TRUE",
    "ServiceAddress": "http://api.a.com:8080",
    "ServiceVpcEnable": "TRUE",
    "MockResult": "test result",
    "ServiceHttpMethod": "POST",
    "ServiceProtocol": "HTTP",
    "ServiceTimeout": 1000,
    "MockHeaders": {
      "MockHeader": [
        {
          "HeaderValue": 86400,
          "HeaderName": "Content-Type"
        }
      ]
    },
    "VpcConfig": {
      "VpcId": "vpc-2zeafsc3fygk1***",
      "InstanceId": "i-bp1h497hkijewv2***",
      "Port": 8080,
      "Name": "glmall-app-test"
    },
    "FunctionComputeConfig": {
      "FcType": "HttpTrigger",
      "RoleArn": "acs:ram::111***:role/aliyunserviceroleforsas",
      "Method": "GET",
      "FcBaseUrl": "https://122xxxxxxx.fc.aliyun.com/2016xxxx/proxy/testSxxx.xxx/testHttp/",
      "ContentTypeValue": "application/x-www-form-urlencoded; charset=UTF-8\n",
      "RegionId": "cn-beijing",
      "OnlyBusinessPath": false,
      "FunctionName": "domain_business_control",
      "ContentTypeCatagory": "DEFAULT",
      "Path": "/api/offline/cacheData",
      "ServiceName": "fcservicename",
      "Qualifier": 2
    }
  },
  "OpenIdConnectConfig": {
    "OpenIdApiType": "IDTOKEN",
    "IdTokenParamName": "xxx",
    "PublicKeyId": 8.848372755692933e+37,
    "PublicKey": "EB1837F8693CCED0BF750B3AD48467BEB569E780A14591CF92"
  },
  "ErrorCodeSamples": {
    "ErrorCodeSample": [
      {
        "Code": "Error",
        "Message": "error message",
        "Description": "Description\n"
      }
    ]
  },
  "ResultDescriptions": {
    "ResultDescription": [
      {
        "Type": "String",
        "Key": "DEMO",
        "HasChild": false,
        "Description": "result description",
        "Pid": "pid",
        "Mandatory": true,
        "Name": "fwqf",
        "Id": "id"
      }
    ]
  },
  "SystemParameters": {
    "SystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": "QueryParamDTO",
        "ParameterName": "CaClientIp",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "CustomSystemParameters": {
    "CustomSystemParameter": [
      {
        "DemoValue": "192.168.1.1",
        "Description": 123,
        "ParameterName": "appid",
        "Location": "HEAD",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ConstantParameters": {
    "ConstantParameter": [
      {
        "Description": 123,
        "Location": "HEAD",
        "ServiceParameterName": "constance",
        "ConstantValue": "constance"
      }
    ]
  },
  "RequestParameters": {
    "RequestParameter": [
      {
        "JsonScheme": {},
        "MaxValue": 123456,
        "ArrayItemsType": "String",
        "MinValue": 123456,
        "DocShow": "PUBLIC",
        "MaxLength": 123456,
        "DefaultValue": 20,
        "ApiParameterName": "age",
        "EnumValue": "boy,girl",
        "DemoValue": 20,
        "Required": "OPTIONAL",
        "Description": "parameter description",
        "ParameterType": "String",
        "RegularExpression": "xxx",
        "MinLength": 123456,
        "DocOrder": 0,
        "Location": "HEAD"
      }
    ]
  },
  "ServiceParameters": {
    "ServiceParameter": [
      {
        "Location": "HEAD",
        "ParameterType": "String",
        "ServiceParameterName": "clientIp"
      }
    ]
  },
  "ServiceParametersMap": {
    "ServiceParameterMap": [
      {
        "RequestParameterName": "sex",
        "ServiceParameterName": "sex"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details