ConfigGroupの情報照会
    • PDF

    ConfigGroupの情報照会

    • PDF

    Article Summary

    VPC環境で利用できます。

    説明

    Cloud Data Streaming Service Config Groupの情報を照会します。

    リクエスト

    リクエストURL

    POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroup/{configGroupNo} [KR]
    POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/cluster/getKafkaConfigGroup/{configGroupNo} [SGN]
    POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/cluster/getKafkaConfigGroup/{configGroupNo} [JPN]
    

    リクエストヘッダ

    ヘッダ名説明
    x-ncp-apigw-timestamp1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、
    API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyNAVERクラウドプラットフォームポータルで発行されたAccess Key ID値
    x-ncp-iam-access-key:{Account Access Key}
    x-ncp-apigw-signature-v2Access Key ID値とSecret Keyで暗号化した署名
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    Content-Typeリクエストボディのコンテンツタイプをapplication/jsonに指定
    Content-Type: application/json

    リクエストパラメータ

    パラメータタイプ必須の有無説明
    configGroupNoStringY- ConfigGroupNo
    対象ConfigGroupの番号
    kafkaVersionCodeStringY- 使用するCloud Data Streaming Serviceバージョン
    getCDSSVersionアクションを通じて取得可能

    リクエスト例

    POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroup/236
    HOST: clouddatastreamingservice.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=
    x-ncp-apigw-timestamp: 1653981745173
    x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
    
    {
      "kafkaVersionCode": "2403005"
    }
    
    curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getKafkaConfigGroup/236" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-ncp-iam-access-key: ANJNnR1jz1gUzaiS0aV2" \
    -H "x-ncp-apigw-timestamp: 1653981745173" \
    -H "x-ncp-apigw-signature-v2: uLWYAZULzt3UZl5MeUo5Xj1mepW49qSMKc9n2rMv/YA=" \
    -d \
    '{
       "kafkaVersionCode" : "2403005"
    }'
    

    レスポンスパラメータ

    public class GetKafkaConfigGroupResponseVo{
        private Integer configGroupNo;
        private String memberNo;
        private String configGroupName;
        private String kafkaVersionCode;
        private String description;
    }
    

    フィールド

    パラメータ名タイプ説明
    configGroupNoIntegerConfigGroup番号
    memberNoStringMember番号
    configGroupNameStringConfigGroup名
    kafkaVersionCodeStringConfigGroupで使用できるKafkaバージョンコード
    descriptionStringユーザーDescription

    レスポンス例(成功)

    {
      "code": 0,
      "message": "SUCCESS",
      "result": {
        "configGroupNo": 236,
        "memberNo": "46",
        "configGroupName": "configgroup-1",
        "kafkaVersionCode": "2403005",
        "description": "コンフィググループ1"
      },
      "requestId": "b3dcf8e3-4111-4ac4-92e1-b80280fb160d"
    }
    

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

    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.