getCloudHadoopNotebookInstanceList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

Cloud Hadoop Notebookのインスタンスリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
regionCode	No	String		リージョンコード - getRegionListアクションを通じて取得可能 - Default: getRegionList照会結果の最初のリージョンを選択
zoneCode	No	String		ZONEコード - Cloud Hadoop Notebookのインスタンスリストを照会する Zoneを決定可能 - getZoneListアクションを通じて取得可能
vpcNo	No	String		VPC番号 - Cloud Hadoop Notebookのインスタンスリストを照会する VPCを決定可能 - getCloudHadoopTargetVpcListアクションを通じて取得可能
subnetNo	No	String		Subnet番号 - Cloud Hadoop Notebookのインスタンスリストを照会する Subnetを決定可能 - getCloudHadoopTargetSubnetListアクションを通じて取得可能
cloudHadoopNotebookName	No	String		Cloud Hadoop Notebook名 - Cloud Hadoop Notebook名でフィルタリングして検索可能 - getCloudHadoopNotebookInstanceListアクションを通じて取得可能
cloudHadoopNotebookInstanceNoList	No	List<String>		Cloud Hadoop Notebookのインスタンス番号リスト - Cloud Hadoop Notebookのインスタンス番号でフィルタリングして検索可能 - getCloudHadoopNotebookInstanceListアクションを通じて取得可能例) cloudHadoopNotebookInstanceNoList.1=1234&cloudHadoopNotebookInstanceNoList.2=2345
cloudHadoopNotebookServerName	No	String		Cloud Hadoop Notebookサーバ名 - Cloud Hadoop Notebookサーバ名でフィルタリングして検索可能 - getCloudHadoopNotebookInstanceListアクションを通じて取得可能
cloudHadoopNotebookServerInstanceNoList	No	List<String>		Cloud Hadoop Notebookサーバインスタンス番号リスト - Cloud Hadoop Notebookサーバインスタンス番号でフィルタリングして検索可能 - getCloudHadoopNotebookInstanceListアクションを通じて取得可能例) cloudHadoopNotebookServerInstanceNoList.1=1234&cloudHadoopNotebookServerInstanceNoList.2=2345
pageNo	No	Integer	Min: 0	ページングされた結果のページ番号 - 結果値を pageNo、pageSizeを利用してページング処理可能
pageSize	Conditional	Integer	Min: 1	ページング時に表示する各ページサイズ - 結果値を pageNo、pageSizeを利用してページング処理可能 - pageNo入力時に入力が必要
responseFormatType	No	String		レスポンス結果のフォーマットタイプ - Options: xml \| json Default: xml

リクエストヘッダ

Cloud Hadoop(VPC) の概要を参照

リクエストボディ

{
  "regionCode": "string",
  "zoneCode": "string",
  "vpcNo": "string",
  "subnetNo": "string",
  "cloudHadoopNotebookName": "string",
  "cloudHadoopNotebookInstanceNoList": [
    "string"
  ],
  "cloudHadoopNotebookServerName": "string",
  "cloudHadoopNotebookServerInstanceNoList": [
    "string"
  ],
  "pageNo": 0,
  "pageSize": 1,
  "responseFormatType": "string"
}

レスポンス

レスポンスボディ

CloudHadoopNotebookInstanceList

エラーコード

Cloud Hadoop(VPC) の概要を参照

例

リクエスト例

GET {API_URL}/getCloudHadoopNotebookInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***87
&subnetNo=***32
&cloudHadoopNotebookName=test-****
&cloudHadoopNotebookInstanceNoList.1=178****
&cloudHadoopNotebookServerName=test-****
&cloudHadoopServerNotebookInstanceNoList.1=1781***
&pageNo=0
&pageSize=10

レスポンス例

{
  "getCloudHadoopNotebookInstanceListResponse": {
    "totalRows": 1,
    "cloudHadoopNotebookInstanceList": [
      {
        "cloudHadoopNotebookInstanceNo": "2766154",
        "cloudHadoopNotebookName": "test12",
        "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
        "cloudHadoopNotebookInstanceStatusName": "running",
        "cloudHadoopNotebookInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudHadoopNotebookInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudHadoopNotebookVersion": {
          "code": "NOTEBOOK1.0",
          "codeName": "Notebook 1.0"
        },
        "cloudHadoopNotebookComponent": {
          "code": "NOTEBOOK_1.0",
          "codeName": "Jupyter notebook 6.4.10 , JupyterLab : 3.2.9"
        },
        "cloudHadoopNotebookServerInstanceList": [
          {
            "cloudHadoopNotebookServerInstanceNo": 2766155,
            "cloudHadoopNotebookServerName": "n-001-test12-15dk-hd",
            "cloudHadoopNotebookServerInstanceStatusName": "running",
            "cloudHadoopNotebookServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopNotebookServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "cloudHadoopNotebookServerRole": {
              "code": "N",
              "codeName": "Notebook Node"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "cpuCount": 4,
            "memorySize": 17179869184,
            "dataStorageSize": 107374182400
          }
        ]
      }
    ],
    "requestId": "182ae8cd-1c30-4618-9954-e4517a88aeb8",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<getCloudHadoopNotebookInstanceListResponse>
  <requestId>4e1ac8f5-b411-474b-83fb-7814aa1c1a7e</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudHadoopNotebookInstanceList>
    <cloudHadoopNotebookInstance>
      <cloudHadoopNotebookInstanceNo>2766154</cloudHadoopNotebookInstanceNo>
      <cloudHadoopNotebookName>test12</cloudHadoopNotebookName>
      <cloudHadoopNotebookImageProductCode>SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050</cloudHadoopNotebookImageProductCode>
      <cloudHadoopNotebookInstanceStatusName>running</cloudHadoopNotebookInstanceStatusName>
      <cloudHadoopNotebookInstanceStatus>
        <code>CREAT</code>
        <codeName>CLOUD DATABASE(VPC) Created State</codeName>
      </cloudHadoopNotebookInstanceStatus>
      <cloudHadoopNotebookInstanceOperation>
        <code>NULL</code>
        <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
      </cloudHadoopNotebookInstanceOperation>
        <cloudHadoopNotebookVersion>
          <code>NOTEBOOK1.0</code>
          <codeName>Notebook 1.0</codeName>
      </cloudHadoopNotebookVersion>
      <cloudHadoopNotebookComponent>
        <code>NOTEBOOK_1.0</code>
        <codeName>Jupyter notebook 6.4.10 , JupyterLab : 3.2.9</codeName>
      </cloudHadoopNotebookComponent>
      <cloudHadoopNotebookServerInstanceList>
        <cloudHadoopNotebookServerInstance>
          <cloudHadoopNotebookServerInstanceNo>2766155</cloudHadoopNotebookServerInstanceNo>
          <cloudHadoopNotebookServerName>n-001-test12-15dk-hd</cloudHadoopNotebookServerName>
          <cloudHadoopNotebookServerInstanceStatusName>running</cloudHadoopNotebookServerInstanceStatusName>
          <cloudHadoopNotebookServerInstanceStatus>
            <code>RUN</code>
            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
          </cloudHadoopNotebookServerInstanceStatus>
          <cloudHadoopNotebookServerInstanceOperation>
            <code>NOOP</code>
            <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
          </cloudHadoopNotebookServerInstanceOperation>
          <cloudHadoopNotebookServerRole>
            <code>N</code>
            <codeName>Notebook Node</codeName>
          </cloudHadoopNotebookServerRole>
          <regionCode>KR</regionCode>
          <zoneCode>KR-2</zoneCode>
          <vpcNo>3977</vpcNo>
          <subnetNo>5747</subnetNo>
          <cpuCount>4</cpuCount>
          <memorySize>17179869184</memorySize>
          <dataStorageSize>107374182400</dataStorageSize>
        </cloudHadoopNotebookServerInstance>
      </cloudHadoopNotebookServerInstanceList>
    </cloudHadoopNotebookInstance>
  </cloudHadoopNotebookInstanceList>
</getCloudHadoopNotebookInstanceListResponse>

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

What's Next

deleteCloudHadoopNotebookInstance

リクエスト
レスポンス
エラーコード
例

タグ