サービスリストの照会
    • PDF

    サービスリストの照会

    • PDF

    記事の要約

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

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

    リクエスト

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

    メソッドURI
    GET/services

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    offsetIntegerOptional照会データのスタート位置
    • デフォルト: 0
    limitIntegerOptional照会データの最大数
    • デフォルト: 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' 
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    servicesArray-サービス情報
    offsetInteger-照会データのスタート位置
    limitInteger-照会データの最大数

    services

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

    フィールドタイプ必須の有無説明
    serviceIdString-サービス ID
    nameString-サービス名
    statusString-サービスの状態
    • scheduled | scheduledLearning | learnable | learning | deleting | deleted | disable | drafted | requestLearning | datasetRequired
      • scheduled: 予約済み
      • scheduledLearning: 予約された学習を実行中
      • learnable: 学習可能
      • learning: 学習実行中
      • deleting: 削除中
      • deleted:削除済み
      • disable: 学習不可
      • drafted: 下書き保存状態
      • requestLearning: 学習リクエスト状態
      • datasetRequired: サービス作成後にデータセットを指定していない状態
    createdDateString-サービスの作成日時
    updatedDateString-サービスの最終更新日時
    actionNameString-照会した項目に対する Sub Account権限
    permissionString-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
    }

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.