Description
For querying the running definition of a specified API in a specified stage. The definition refers to the one taking effect in the specified stage, and may be different from the definition being edited.
- This function is intended for API activators.
- The interface is used to query a specified API’s definition that is already released to a specified stage. The definition is running in the stage and may be different from the definition being modified. Only when the modified definition is released to the stage can the modified definition overwrite the definition of the API that is running in the stage.
Request parameters
Name | Type | Required? | Description |
---|---|---|---|
Action | String | Yes | Operation interface, which is a required parameter; value: DescribeDeployedApi |
GroupId | String | No | ID of the specified group |
ApiId | String | Yes | ID of the specified API |
StageName | String | Yes | Stage name; values:
|
Return parameters
Name | Type | Description |
---|---|---|
RequestId | String | ID of the current request |
RegionId | String | Region where the API is located |
GroupId | String | API group ID |
GroupName | String | API group name |
StageName | String | Stage name; values:
|
ApiId | String | ID of the API |
ApiName | String | API name |
Description | String | API description |
Visibility | String | Visibility; values: PUBLIC and PRIVATE, indicating a public API and a private API respectively |
AuthType | String | Security authentication method; values: app and ANONYMOUS, indicating Alibaba Cloud app and anonymous type respectively. |
ResultType | String | Type returned |
ResultSample | String | Example returned |
FailResultSample | String | Sample of the reply failure returned by the backend service. |
DeployedTime | String | Release time (Greenwich mean time) |
ErrorCodeSamples | ErrorCodeSample | Sample of the error code returned by the backend service. For more information, see ApiAttributesType.md#ErrorCodeSamples. |
RequestConfig | RequestConfig | Returned API front-end definition information, in a format consisting of RequestConfig |
ServiceConfig | ServiceConfig | Returned information on the backend service called through the API, in a format consisting of ServiceConfig |
SystemParameters | SystemParameter | Returned system parameter items input when a backend service is called through the API, in an array consisting of SystemParameter |
ConstantParameters | ConstantParameter | Returned system parameter items input when a backend service is called through the API, in an array consisting of ConstantParameter |
RequestParameters | RequestParameter | Returned front-end input parameter information items in the API, in an array consisting of RequestParameter |
ServiceParameters | ServiceParameter | Returned system parameter items input when a backend service is called through the API, in an array consisting of ServiceParameter |
ServiceParametersMap | ServiceParameterMap | Returned mappings between front-end and back-end parameters in the API, in an array consisting of ServiceParameterMap |
Examples
Request example
https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeDeployedApi
&ApiId=3b81fd160f5645e097cc8855d75a1cf6
&StageName=RELEASE
&<Public request parameters>
Example returned
XML
format
<DescribeDeployedApiResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
<RegionId>cn-qingdao</RegionId>
<GroupId>0009db9c828549768a200320714b8930</GroupId>
<GroupName>myGroup2</GroupName>
<StageName>RELEASE</StageName>
<ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>
<ApiName>creatobject</ApiName>
<Description> Object creation</Description>
<Visibility>public</Visibility>
<AuthType>APP</AuthType>
<ResultType>application/json</ResultType>
<ResultSample></ResultSample>
<FailResultSample></FailResultSample>
<DeployedTime>2016-07-23T08:28:48Z</DeployedTime>
<RequestConfig>
<RequestProtocol>HTTP</RequestProtocol>
<RequestHttpMethod>GET</RequestHttpMethod>
<RequestPath>/mypath/creatobject</RequestPath>
<BodyFormat>FORM</BodyFormat>
<PostBodyDescription> Object</PostBodyDescription>
</RequestConfig>
<ServiceConfig>
<ServiceProtocol>HTTP/HTTPS</ServiceProtocol>
<ServiceAddress>http://api.a.com:8080</ServiceAddress>
<ServiceHttpMethod>GET</ServiceHttpMethod>
<ServicePath>/object/add</ServicePath>
<ServiceTimeout>2000</ServiceTimeout>
</ServiceConfig>
<SystemParameters>
<SystemParameter>
<ParameterName>CaRequestId</ParameterName>
<ServiceParameterName>RequestId</ServiceParameterName>
<Location>HEAD</Location>
<DemoValue>0A964636-F7A3-4F1A-92D7-135584A6397F</DemoValue>
<Description> Request ID</Description>
</SystemParameter>
<SystemParameter>
<ParameterName>CaAppId</ParameterName>
<ServiceParameterName>AppId</ServiceParameterName>
<Location>QUERY</Location>
<DemoValue>0A964636-F7A3-4F1A-92D7-135584A6398F</DemoValue>
<Description> Requester application ID</Description>
</SystemParameter>
</SystemParameters>
<ConstantParameters>
<ConstantParameter>
<ServiceParameterName>ConstantKey1</ServiceParameterName>
<ConstantValue>helloworld</ConstantValue>
<Location>QUERY</Location>
<Description>Desc</Description>
</ConstantParameter>
</ConstantParameters>
<RequestParameters>
<RequestParameter>
<ApiParameterName>RequestKey1</ApiParameterName>
<Location>QUERY</Location>
<ParameterType>String</ParameterType>
<Required>REQUIRED</Required>
<DefaultValue></DefaultValue>
<DemoValue>demo1</DemoValue>
<MaxValue></MaxValue>
<MinValue></MinValue>
<MaxLength>100</MaxLength>
<MinLength>3</MinLength>
<RegularExpression></RegularExpression>
<JsonScheme></JsonScheme>
<EnumValue></EnumValue>
<DocShow>PUBLIC</DocShow>
<DocOrder>1</DocOrder>
<Description>Desc1</Description>
</RequestParameter>
<RequestParameter>
<ApiParameterName>RequestKey2</ApiParameterName>
<Location>QUERY</Location>
<ParameterType>Number</ParameterType>
<Required>OPTIONAL</Required>
<DefaultValue></DefaultValue>
<DemoValue>12</DemoValue>
<MaxValue>120</MaxValue>
<MinValue>100</MinValue>
<MaxLength></MaxLength>
<MinLength></MinLength>
<RegularExpression></RegularExpression>
<JsonScheme></JsonScheme>
<EnumValue></EnumValue>
<DocShow>PUBLIC</DocShow>
<DocOrder>2</DocOrder>
<Description>Desc2</Description>
</RequestParameter>
</RequestParameters>
<ServiceParameters>
<ServiceParameter>
<ServiceParameterName>ServiceKey1</ServiceParameterName>
<Location>QUERY</Location>
<ParameterType>String</ParameterType>
</ServiceParameter>
<ServiceParameter>
<ServiceParameterName>ServiceKey2</ServiceParameterName>
<Location>QUERY</Location>
<ParameterType>Number</ParameterType>
</ServiceParameter>
</ServiceParameters>
<ServiceParametersMap>
<ServiceParameterMap>
<ServiceParameterName>RequestKey1</ServiceParameterName>
<RequestParameterName>ServiceKey1</RequestParameterName>
</ServiceParameterMap>
<ServiceParameterMap>
<ServiceParameterName>RequestKey2</ServiceParameterName>
<RequestParameterName>ServiceKey2</RequestParameterName>
</ServiceParameterMap>
</ServiceParametersMap>
<ErrorCodeSamples>
<ErrorCodeSample>
<Code>400</Code>
<Message>Missing the parameter UserId</Message>
<Description> Request where the parameter UserId is missing</Description>
</ErrorCodeSample>
</ErrorCodeSamples>
</DescribeDeployedApiResponse>
JSON
format
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
"RegionId": "cn-qingdao",
"GroupId": "0009db9c828549768a200320714b8930",
"GroupName": "myGroup2",
"StageName": "RELEASE",
"ApiId": "3b81fd160f5645e097cc8855d75a1cf6",
"ApiName": "creatobject",
"Description": " Object creation",
"Visibility": "public",
"AuthType": "APP",
"ResultType": "application/json",
"DeployedTime": "2016-07-23T08:28:48Z",
"RequestConfig": {
"RequestProtocol": "HTTP",
"RequestHttpMethod": "GET",
"RequestPath": "/mypath/creatobject",
"BodyFormat": "FORM",
"PostBodyDescription": " Object"
},
"ServiceConfig": {
"ServiceProtocol": "HTTP/HTTPS",
"ServiceAddress": "http://api.a.com:8080",
"ServiceHttpMethod": "GET",
"ServicePath": "/object/add",
"ServiceTimeout": "2000"
},
"SystemParameters": {
"SystemParameter": [
{
"ParameterName": "CaRequestId",
"ServiceParameterName": "RequestId",
"Location": "HEAD",
"DemoValue": "0A964636-F7A3-4F1A-92D7-135584A6397F",
"Description": " Request ID"
},
{
"ParameterName": "CaAppId",
"ServiceParameterName": "AppId",
"Location": "QUERY",
"DemoValue": "0A964636-F7A3-4F1A-92D7-135584A6398F",
"Description": " Requester application ID"
}
]
},
"ConstantParameters": {
"ConstantParameter": {
"ServiceParameterName": "ConstantKey1",
"ConstantValue": "helloworld",
"Location": "QUERY",
"Description": "Desc"
}
},
"RequestParameters": {
"RequestParameter": [
{
"ApiParameterName": "RequestKey1",
"Location": "QUERY",
"ParameterType": "String",
"Required": "REQUIRED",
"DemoValue": "demo1",
"MaxLength": "100",
"MinLength": "3",
"DocShow": "PUBLIC",
"DocOrder": "1",
"Description": "Desc1"
},
{
"ApiParameterName": "RequestKey2",
"Location": "QUERY",
"ParameterType": "Number",
"Required": "OPTIONAL",
"DemoValue": "12",
"MaxValue": "120",
"MinValue": "100",
"DocShow": "PUBLIC",
"DocOrder": "2",
"Description": "Desc2"
}
]
},
"ServiceParameters": {
"ServiceParameter": [
{
"ServiceParameterName": "ServiceKey1",
"Location": "QUERY",
"ParameterType": "String"
},
{
"ServiceParameterName": "ServiceKey2",
"Location": "QUERY",
"ParameterType": "Number"
}
]
},
"ServiceParametersMap": {
"ServiceParameterMap": [
{
"ServiceParameterName": "RequestKey1",
"RequestParameterName": "ServiceKey1"
},
{
"ServiceParameterName": "RequestKey2",
"RequestParameterName": "ServiceKey2"
}
]
},
"ErrorCodeSamples": {
"ErrorCodeSample": [
{
"Code": "400",
"Message": "Missing the parameter UserId",
"Description": " Request where the parameter UserId is missing"
}
]
}
}