create
- 印刷する
- PDF
create
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
Notebookを作成します。
リクエスト
リクエストパラメータ
パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
---|---|---|---|---|
accountId | YES | String | - アカウント識別子の UUID(base62) - accountIdは AccountsのgetList APIを通じて取得可能 | |
addStorage | YES | Boolean | trueの場合、storageType、storageGBは入力必須 | - 別途 Block Storageの使用有無 デフォルト: false |
bucketName | Yes | String | - バケット名 - Object Storageにデータを保存するための空間を意味 - ロック設定されていないバケットと連携 - 連携されたバケットは、その後にロック設定できない | |
loginKeyName | YES | String | - loginKeyNameは NotebooksのgetLoginKeyList APIを通じて取得可能 | |
name | YES | String | 3~15文字以内で入力 英字の小文字、数字、ハイフン(-)のみ使用可能 先頭文字は英字、末尾文字は英字または数字のみ使用可能 | - ノートブック名 - 重複して使用不可 |
serverTypeCode | YES | String | - serverTypeCode NotebooksのgetServerTypeList APIを通じて確認可能 | |
storageGB | NO | Integer | 100~2000または4000、6000のみ入力可能 | - 追加 Block Storageの容量 |
storageType | NO | String | - 追加 Block Storageのタイプ オプション: SSD | HDD デフォルト: SSD | |
subnetNo | YES | Integer | - subnetNoは NotebooksのgetSubnetList APIを通じて確認可能 | |
typeCode | YES | String | - typeCodeは NotebooksのgetTypeList APIを通じて確認可能 | |
typeName | YES | String | - typeNameは NotebooksのgetTypeList APIを通じて確認可能 | |
userConfigurations | YES | String | - userConfigurationsは NotebooksのgetUserConfigurationSpecList APIを通じて確認可能 | |
vpcNo | YES | Integer | - vpcNoは NotebooksのgetVpcList APIを通じて確認可能 |
リクエストヘッダ
リクエストボディ
- JSON
{ "accountId": "string", "addStorage": false, "loginKeyName": "string", "name": "string", "serverTypeCode": "string", "storageGB": 0, "storageType": "string", "subnetNo": 0, "typeCode": "string", "typeName": "string", "userConfigurations": [ { "componentName": "string", "name": "string", "value": "string" } ], "vpcNo": 0 }
- XML
<?xml version="1.0" encoding="UTF-8"?> <CreateNotebookRequest> <accountId>string</accountId> <addStorage>true</addStorage> <loginKeyName>string</loginKeyName> <name>string</name> <serverTypeCode>string</serverTypeCode> <storageGB>0</storageGB> <storageType>string</storageType> <subnetNo>0</subnetNo> <typeCode>string</typeCode> <typeName>string</typeName> <userConfigurations> <componentName>string</componentName> <name>string</name> <value>string</value> </userConfigurations> <vpcNo>0</vpcNo> </CreateNotebookRequest>
レスポンス
レスポンスボディ
- JSON
{ "id": "string", "message": "string", "success": true }
- XML
<?xml version="1.0" encoding="UTF-8"?> <CreateNotebookResponse> <id>string</id> <message>string</message> <success>true</success> </CreateNotebookResponse>
エラーコード
例
リクエスト例
HTTP
POST https://df.apigw.ntruss.com/api/v2/notebooks/create HOST: df.apigw.ntruss.com Content-Type: application/json x-ncp-apigw-timestamp: 1505290625682 x-ncp-iam-access-key: D78BB444D6D3C84CA38A x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo= { "accountId": "6COytUeFjA7b8eOhqdL5zL", "addStorage": false, "loginKeyName": "user-api-key", "name": "api-notebook", "serverTypeCode": "SVR.DFRNT.STAND.C004.M016.HDD.B050.G002", "subnetNo": 83356, "typeCode": "SW.DFRNT.OS.LNX64.CNTOS.0708.B050", "typeName": "Jupyter Lab", "userConfigurations": [ { "name": "Access Password", "value": "testTest123@", "componentName": "Jupyter Lab", "regularExpression": "^(?=.*[0-9])(?=.*[a-zA-Z])(?=.*[!@#$%^+\\-=]).{8,20}$", "isMasking": true, "isMandatory": true } ], "vpcNo": 34754 }
BASH
curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/create" \ -H "accept: application/json" -H "Content-Type: application/json" \ -H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \ -H "x-ncp-apigw-timestamp: 1685414533742" \ -H "x-ncp-apigw-signature-v2: h4OnKdkbBcxSfc1w02qCLdSX/cFWdqwZUE57jVQYcSA=" \ -d "{ \"accountId\": \"6COytUeFjA7b8eOhqdL5zL\", \"addStorage\": false, \"loginKeyName\": \"user-api-key\", \"name\": \"api-notebook\", \"serverTypeCode\": \"SVR.DFRNT.STAND.C004.M016.HDD.B050.G002\", \"subnetNo\": 83356, \"typeCode\": \"SW.DFRNT.OS.LNX64.CNTOS.0708.B050\", \"typeName\": \"Jupyter Lab\", \"userConfigurations\": [ { \"name\": \"Access Password\", \"value\": \"testTest123@\", \"componentName\": \"Jupyter Lab\", \"regularExpression\": \"^(?=.*[0-9])(?=.*[a-zA-Z])(?=.*[!@#$%^+\\\\-=]).{8,20}$\", \"isMasking\": true, \"isMandatory\": true } ], \"vpcNo\": 34754 }"
レスポンス例
HTTP
HTTP Status Description 200 OK BASH
{ "success": true, "id": "8xCT2TqPHPlakNZztTf3qx" }
エラーコードの例
HTTP
HTTP Status Description 403 not allowed to access BASH
{ "message": "invalid request parameter (constraint violation Not available, notebook user configuration 'Jupyter Lab.Access Password')", "success": false }
この記事は役に立ちましたか?