edit-icon download-icon

Query the API stage

Last Updated: May 17, 2017

Description

This function is for querying the details about a specified stage of an API group.

  • This function is intended for API providers.
  • The DescribeApiStage interface is used to query the details about a specified stage.

Request parameters

Name Type Required? Description
Action String Yes Interface name, which is a required parameter; value: DescribeApiStage.
GroupId String Yes API group ID.
StageId String Yes Stage ID.

Returned parameters

Name Type Description
RequestId String Unique request ID.
GroupID String API group ID.
StageID String Stage ID.
StageName String Stage name.
Description String Stage description.
CreatedTime String Creation time (Greenwich mean time).
ModifiedTime String Last modification time (Greenwich mean time).
Variables VariableItem Variable information.

Examples

Request example

  1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeApiStage
  2. &GroupId=523e8dc7bbe04613b5b1d726c2a7889d
  3. &StageId=6EF60BEC-0242-43AF-BB20-270359FB54A7
  4. &<Public request parameters>

Response example

XML format

  1. <DescribeApiStageResponse>
  2. <RequestId>03442A3D-3B7D-434C-8A95-A5FEB989B529</RequestId>
  3. <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
  4. <StageID>123e8dc7bbe01613b5b1d726c2a7887e</StageID>
  5. <StageName>RELEASE</StageName>
  6. <Description>myRELEASE</Description>
  7. <CreatedTime>2016-08-01T06:53:02Z</CreatedTime>
  8. <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>
  9. <Status>NORMAL</Status>
  10. <BillingStatus>NORMAL</BillingStatus>
  11. <IllegalStatus>NORMAL</IllegalStatus>
  12. <TrafficLimit>500</TrafficLimit>
  13. <Variables>
  14. <VariableItem>
  15. <VariableName>serverName</VariableName>
  16. <VariableValue>api.domain.com</VariableValue>
  17. </VariableItem>
  18. <VariableItem>
  19. <VariableName>version</VariableName>
  20. <VariableValue>v1.0</VariableValue>
  21. </VariableItem>
  22. </Variables>
  23. </DescribeApiStageResponse>

JSON format

  1. {
  2. "RequestId": "03442A3D-3B7D-434C-8A95-A5FEB989B529",
  3. "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  4. "StageID": "123e8dc7bbe01613b5b1d726c2a7887e",
  5. "StageName": "RELEASE",
  6. "Description": "myRELEASE",
  7. "CreatedTime": "2016-08-01T06:53:02Z",
  8. "ModifiedTime": "2016-08-01T06:54:32Z",
  9. "Status": "NORMAL",
  10. "BillingStatus": "NORMAL",
  11. "IllegalStatus": "NORMAL",
  12. "TrafficLimit": "500",
  13. "Variables": {
  14. "VariableItem": [
  15. {
  16. "VariableName": "serverName",
  17. "VariableValue": "api.domain.com"
  18. },
  19. {
  20. "VariableName": "version",
  21. "VariableValue": "v1.0"
  22. }
  23. ]
  24. }
  25. }
Thank you! We've received your feedback.