サービスリストの照会

Classic/VPC環境で利用できます。

作成されたサービスの全リストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/services

リクエストヘッダ

AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`offset`	Integer	Optional	照会データのスタート位置デフォルト: 0
`limit`	Integer	Optional	照会データの最大数デフォルト: 1,000

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`services`	Array	-	サービス情報
`offset`	Integer	-	照会データのスタート位置
`limit`	Integer	-	照会データの最大数

`services`

servicesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`serviceId`	String	-	サービス ID
`name`	String	-	サービス名
`status`	String	-	サービスの状態 `scheduled` \| `scheduledLearning` \| `learnable` \| `learning` \| `deleting` \| `deleted` \| `disable` \| `drafted` \| `requestLearning` \| `datasetRequired` `scheduled`: 予約済み `scheduledLearning`: 予約された学習を実行中 `learnable`: 学習可能 `learning`: 学習実行中 `deleting`: 削除中 `deleted`:削除済み `disable`: 学習不可 `drafted`: 下書き保存状態 `requestLearning`: 学習リクエスト状態 `datasetRequired`: サービス作成後にデータセットを指定していない状態
`createdDate`	String	-	サービスの作成日時
`updatedDate`	String	-	サービスの最終更新日時
`actionName`	String	-	照会した項目に対する Sub Account権限
`permission`	String	-	Sub Account権限を許可するかどうか

レスポンスステータスコード

AiTEMS APIで共通して使用されるレスポンスステータスコードの詳細は、AiTEMS APIの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "services": [
        {
            "serviceId": "b28ao******",
            "name": "String",
            "status": "datasetRequired",
            "createdDate": "2024-07-29T17:28:39.698",
            "updatedDate": "2024-07-29T17:28:39.698",
            "actionName": "View/getServiceDetail",
            "permission": "Allow"
        },
        {
            "serviceId": "fboyb******",
            "name": "service",
            "status": "datasetRequired",
            "createdDate": "2024-07-29T16:17:37.235",
            "updatedDate": "2024-07-29T16:17:37.235",
            "actionName": "View/getServiceDetail",
            "permission": "Allow"
        }
    ],
    "offset": 0,
    "limit": 1000
}