通过

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

Api Issue - List By Service

  • 参考
服务:
API Management
API 版本:
2024-05-01

列出与指定 API 关联的所有问题。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues?api-version=2024-05-01
具有可选参数: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues?$filter={$filter}&expandCommentsAttachments={expandCommentsAttachments}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI 参数

名称 在 必需 类型 说明
apiId
 path True

string

minLength: 1
maxLength: 80

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

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

API 管理服务的名称。
subscriptionId
 path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。
api-version
 query True

string

minLength: 1

用于此作的 API 版本。
$filter
 query

string

|字段 |用法 |支持的运算符 |支持的函数 |
|-------------|-------------|-------------|-------------|
|name |filter |ge， le， eq， ne， gt， lt |substringof， contains， startswith， endswith |
|userId |filter |ge， le， eq， ne， gt， lt |substringof， contains， startswith， endswith |
|state |filter |eq | |
$skip
 query

integer (int32)

minimum: 0

要跳过的记录数。
$top
 query

integer (int32)

minimum: 1

要返回的记录数。
expandCommentsAttachments
 query

boolean

展开批注附件。

响应

名称 类型 说明
200 OK

IssueCollection

API 问题的分页结果响应。
Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementListApiIssues

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues?api-version=2024-05-01

示例响应

状态代码:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/apis/issues",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "title": "New API issue",
        "description": "New API issue description",
        "createdDate": "2018-02-01T22:21:20.467Z",
        "state": "open",
        "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
IssueCollection

分页问题列表表示形式。
IssueContract

问题合同详细信息。
State

问题的状态。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

IssueCollection

Object

分页问题列表表示形式。

名称 类型 说明
count

integer (int64)

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

string

下一页链接（如果有）。
value

IssueContract[]

问题值。

IssueContract

Object

问题合同详细信息。

名称 类型 说明
id

string

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

资源的名称
properties.apiId

string

为问题创建的 API 的资源标识符。
properties.createdDate

string (date-time)

创建问题的日期和时间。
properties.description

string

描述问题的文本。
properties.state

State

问题的状态。
properties.title

string

问题标题。
properties.userId

string

用户的资源标识符创建了问题。
type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

State

枚举

问题的状态。

值 说明
closed

此问题已关闭。
open

此问题已打开。
proposed

建议此问题。
removed

此问题已删除。
resolved

此问题现已解决。