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 |
Single Sign-On 관련 구성 |
url | 'public'이 true일 때 노출되는 API 포털의 URL입니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다. |
속성 세부 정보
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
'public'이 true일 때 노출되는 API 포털의 URL입니다. 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
url?: string
속성 값
string