Cloud Data Streaming Service
- 印刷する
- PDF
Cloud Data Streaming Service
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
VPC環境の Cloud Data Streaming Serviceサーバインスタンス(VM)リストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api/{regionCode}-v1/vpc/servers/cdss |
リクエストヘッダ
Cloud Log Analytics APIで共通して使用されるヘッダの詳細は、Cloud Log Analyticsのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode | String | Required | リージョンコード
|
リクエストクエリパラメータ
リクエストパスパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
pageNo | Integer | Optional | ページ番号
|
pageSize | Integer | Optional | ページごとの項目数
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/vpc/servers/cdss' \
--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' \
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
code | Integer | - | レスポンスステータスコード |
message | String | - | レスポンスステータスメッセージ |
result | Object | - | レスポンス結果 |
result.pageSize | Integer | - | ページごとの項目数 |
result.currentPage | Integer | - | 現在のページ番号 |
result.totalPage | Integer | - | ページの総数 |
result.totalCount | Integer | - | 総項目数 |
result.isPaged | Boolean | - | ページングするかどうか
|
result.clusterInfoList | Array | - | サーバリスト
|
参考
Server情報関連フィールド(clusterInfoList
)の詳細は、Cloud Data Streaming Service APIガイドとCloud Data Streaming Serviceご利用ガイドをご参照ください。
レスポンスステータスコード
Cloud Log Analytics APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Log Analyticsのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": 0,
"message": "リクエストが正常に処理されました。",
"result": {
"pageSize": 10,
"currentPage": 1,
"totalPage": 1,
"totalCount": 1,
"isPaged": true,
"clusterInfoList": [
{
"clusterName": "cdss-test",
"serverStatus": "実行中",
"serverStatusColor": "green",
"kafkaVersion": "3.7.1",
"vpcName": "test"
}
]
}
}
この記事は役に立ちましたか?