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 Management サービスインスタンスで一意である必要があります。
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 Management サービスの名前。
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 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementListApiIssues

要求のサンプル

HTTP

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。例 - /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	これで問題は解決されました。

次の方法で共有

Api Issue - List By Service

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementListApiIssues

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IssueCollection

IssueContract

State

その他のリソース