ApiPortalProperties interface
API ポータルのプロパティ ペイロード
プロパティ
api |
API の試用機能が有効か無効かを示します。 有効にすると、ユーザーは API ポータルで要求を送信し、応答を表示することで API を試すことができます。 無効にすると、ユーザーは API を試すことができません。 |
gateway |
API ポータルと統合するゲートウェイのリソース ID の配列。 |
https |
https のみが許可されているかどうかを示します。 |
instances | インスタンスのコレクションは API ポータルに属します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
provisioning |
API ポータルの状態。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
public | API ポータルがエンドポイントを公開するかどうかを示します。 |
resource |
必要な CPU とメモリに対して要求されたリソース量。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
source |
OpenAPI ソース URL の場所のコレクション。 |
sso |
シングル サインオン関連の構成 |
url | API ポータルの URL。'public' が true の場合に公開されます。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
プロパティの詳細
apiTryOutEnabledState
API の試用機能が有効か無効かを示します。 有効にすると、ユーザーは API ポータルで要求を送信し、応答を表示することで API を試すことができます。 無効にすると、ユーザーは API を試すことができません。
apiTryOutEnabledState?: string
プロパティ値
string
gatewayIds
API ポータルと統合するゲートウェイのリソース ID の配列。
gatewayIds?: string[]
プロパティ値
string[]
httpsOnly
https のみが許可されているかどうかを示します。
httpsOnly?: boolean
プロパティ値
boolean
instances
インスタンスのコレクションは API ポータルに属します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
instances?: ApiPortalInstance[]
プロパティ値
provisioningState
API ポータルの状態。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
provisioningState?: string
プロパティ値
string
public
API ポータルがエンドポイントを公開するかどうかを示します。
public?: boolean
プロパティ値
boolean
resourceRequests
必要な CPU とメモリに対して要求されたリソース量。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
resourceRequests?: ApiPortalResourceRequests
プロパティ値
sourceUrls
OpenAPI ソース URL の場所のコレクション。
sourceUrls?: string[]
プロパティ値
string[]
ssoProperties
url
API ポータルの URL。'public' が true の場合に公開されます。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
url?: string
プロパティ値
string