All Products
Search
Document Center

API Gateway:DescribeStageModels

Last Updated:May 25, 2026

Retrieves a list of stage models.

Operation description

  • This operation supports fuzzy search.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

StageAlias

string

No

The alias of the stage.

生产环境

StageName

string

No

The name of the stage.

RELEASE

PageNumber

integer

No

The number of the page to return.

1

PageSize

integer

No

The number of entries to return per page.

10

Response elements

Element

Type

Description

Example

object

PageNumber

integer

The number of the page returned.

1

RequestId

string

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZxxx

PageSize

integer

The number of entries returned per page.

10

TotalCount

integer

The total number of entries that match the query.

1

StageModelInfoList

array<object>

A list of stage models.

object

StageModelId

string

The ID of the stage model.

j3j435j23l4j23l55xxx

StageAlias

string

The alias of the stage.

生产环境

StageName

string

The name of the stage.

PRE

Type

string

The stage type.

CUSTOM

Description

string

The description of the stage.

Stage description

ModifiedTime

string

The modification time.

2024-12-10T00:01:09Z

CreatedTime

string

The creation time.

2025-08-13T01:54:03Z

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZxxx",
  "PageSize": 10,
  "TotalCount": 1,
  "StageModelInfoList": [
    {
      "StageModelId": "j3j435j23l4j23l55xxx",
      "StageAlias": "生产环境",
      "StageName": "PRE",
      "Type": "CUSTOM",
      "Description": "Stage description",
      "ModifiedTime": "2024-12-10T00:01:09Z",
      "CreatedTime": "2025-08-13T01:54:03Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.