你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Api Revision - List By Service

列出 API 的所有修订版。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI 参数

名称 必需 类型 说明
apiId
path True

string

API 标识符。 在当前API 管理服务实例中必须是唯一的。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

$filter
query

string

|字段 |使用情况 |支持的运算符 |支持的函数 |
|-------------|-------------|-------------|-------------|
|apiRevision |filter |ge、le、eq、ne、gt、lt |substringof、 contains、 startswith、 endswith |

$skip
query

integer

int32

要跳过的记录数。

$top
query

integer

int32

要返回的记录数。

响应

名称 类型 说明
200 OK

ApiRevisionCollection

该操作返回修订详细信息的列表。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementListApiRevisions

示例请求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/revisions?api-version=2022-08-01

示例响应

{
  "value": [
    {
      "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1",
      "apiRevision": "1",
      "createdDateTime": "2018-02-01T22:21:20.467Z",
      "updatedDateTime": "2018-02-01T22:21:20.467Z",
      "isOnline": true,
      "isCurrent": true
    }
  ],
  "count": 1,
  "nextLink": ""
}

定义

名称 说明
ApiRevisionCollection

分页 API 修订列表表示形式。

ApiRevisionContract

修订元数据摘要。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

ApiRevisionCollection

分页 API 修订列表表示形式。

名称 类型 说明
count

integer

所有页面的总记录计数数。

nextLink

string

下一页链接(如果有)。

value

ApiRevisionContract[]

页面值。

ApiRevisionContract

修订元数据摘要。

名称 类型 说明
apiId

string

API 修订的标识符。

apiRevision

string

API 的修订号。

createdDateTime

string

创建 API 修订的时间。 日期符合 ISO 8601 标准指定的以下格式:yyyy-MM-ddTHH:mm:ssZ。

description

string

API 修订的说明。

isCurrent

boolean

指示是否可通过网关访问 API 修订。

isOnline

boolean

指示 API 修订是否为当前 API 修订。

privateUrl

string

用于访问非当前 API 修订的网关 URL。

updatedDateTime

string

API 修订的更新时间。 日期符合 ISO 8601 标准指定的以下格式:yyyy-MM-ddTHH:mm:ssZ。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误的情况下,在请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。