CLOVA Speech

https://guide.ncloud-docs.com/docs/en
Admin
CLOVA Speech is a speech recognition service powered by NEST technology that converts media files to...
Tokens:91,115
Snippets:784
Trust Score:5.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install AWS SDK for Javascript

Source: https://guide.ncloud-docs.com/docs/en/storage-storage-8-4

Instructions on how to install the specific version of the AWS SDK for Javascript required for these examples.

```APIDOC
## Install SDK

To use the provided examples, install the AWS SDK for Javascript with the following npm command:

```bash
npm install --save aws-sdk@2.348.0
```

*   **AWS Javascript SDK source:** https://github.com/aws/aws-sdk-js
*   **Related document:** https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html
```

--------------------------------

### Install AWS SDK for JavaScript

Source: https://guide.ncloud-docs.com/docs/en/storage-storage-8-4

Installs the AWS SDK for JavaScript, version 2.348.0, using npm. This is a prerequisite for using the provided examples.

```bash
npm install --save aws-sdk@2.348.0

```

--------------------------------

### Main Installation Logic (Bash)

Source: https://guide.ncloud-docs.com/docs/en/cloudinsight-howtomove

This section orchestrates the agent installation process by calling the cleanup and installation functions in sequence. It first removes old configurations and then proceeds with installing the new Cloud Insight agent.

```Bash
# ====================
# | Main Logic Start |
# ====================
rc_local_remove
nsight_remove
nsight_updater_remove
cloud_insight_install
cleansing
```

--------------------------------

### Run Signing Helper CLI Commands

Source: https://guide.ncloud-docs.com/docs/en/external-access-signing-helper-cli

Demonstrates how to run basic commands for the Signing Helper CLI, including checking the version, getting help, and initiating the credential process. These commands help verify installation and understand CLI functionality.

```bash
./ncp_signing_helper version
```

```bash
./ncp_signing_helper help
```

```bash
./ncp_signing_helper credential-process --help
```

--------------------------------

### Install Cloud Insight Agent V3 (Bash)

Source: https://guide.ncloud-docs.com/docs/en/cloudinsight-howtomove

This function installs the Cloud Insight Agent V3. It first checks if an older version exists and stops it, then downloads the agent installer, extracts it, and runs the installation script with the appropriate parameters determined by the OS detection logic.

```Bash
function cloud_insight_install() {
   if [ -d /home1/nbpmon/agent_controller_linux ]; then
       systemctl stop nsight-agent
       rm -rf /home1/nbpmon/agent_controller_linux
   fi
   wget -t 1 --timeout=5 --spider ${AGENT_INSTALLER} --no-check-certificate
   if [[ 0 -eq $? ]]; then
        wget -nv -t 1 --timeout=5 -O ${AGENT_DIR}/${AGENT_FILE} ${AGENT_INSTALLER} --no-check-certificate
        tar zxvf ${AGENT_DIR}/${AGENT_FILE} -C ${AGENT_DIR}
        bash ${AGENT_DIR}/agent_controller_linux/install_agent.sh ${AGENT_INSTALL_PARAMETER}
        echo
        echo "Install Cloud Insight(V3) Agent Files >> Success"
        echo
   fi
}
```

--------------------------------

### Clean up Agent Installation Files (Bash)

Source: https://guide.ncloud-docs.com/docs/en/cloudinsight-howtomove

This function performs cleanup after agent installation, including removing the downloaded agent archive file and any system startup links created for the agent. It handles different operating systems by targeting appropriate directories for startup scripts.

```Bash
function cleansing() {

    local NOMS_NSIGHT="K01noms_nsight"

    REMOVE_FILE_LIST="$AGENT_DIR/$AGENT_FILE"
    for REMOVE_FILE in $REMOVE_FILE_LIST
    do
        rm -f $REMOVE_FILE
    done

    if [ $OS == "CentOS" ]; then
        for ((i=0; i<=6; i++))
        do
            rm -f /etc/rc.d/rc$i.d/$NOMS_NSIGHT
        done
    elif [ $OS == "Ubuntu" ]; then
        for ((i=0; i<=6; i++))
        do
            rm -f /etc/rc$i.d/$NOMS_NSIGHT
        done
    fi
}
```

--------------------------------

### Run App Safer SDK Initialization

Source: https://guide.ncloud-docs.com/docs/en/appsafer-android

This code demonstrates how to initialize the App Safer SDK using the start() function. It is provided in both Kotlin and Java, with a note recommending to call this function from a separate thread to avoid ANR errors due to network communication.

```Kotlin
@Throws(AppSaferException::class)
fun start(context: Context)

```

```Java
void start(Context context) throws AppSaferException;

```

```Kotlin
runBlocking {
    AppSafer.INSTANCE.start(applicationContext)
}

```

```Java
Thread thread = new Thread(new Runnable() {
    @Override
    public void run() {
        AppSafer.INSTANCE.start(getApplicationContext());
    }
});
thread.start(); 

```

--------------------------------

### Install Cloud Insight Agent on Bare Metal

Source: https://guide.ncloud-docs.com/docs/en/cloudinsight-howtomove

This command installs the Cloud Insight agent on a Bare Metal server. It navigates to the agent controller directory and executes the install_agent.bat script with the 'classic' parameter. Ensure the agent_controller_windows folder exists and the script is accessible.

```bash
agent_controller_windows\install_agent.bat classic
```

--------------------------------

### Download Cloud Insight Agent package for Bare Metal

Source: https://guide.ncloud-docs.com/docs/en/cloudinsight-howtomove

This command downloads the Cloud Insight agent installation package for a Bare Metal environment using wget. It specifies the URL for the package and includes an option to skip certificate checks. The downloaded file is saved to the current directory.

```bash
wget https://repo-nsight.ncloud.com/agent_controller_windows_pub_bm.zip --no-check-certificate
```

--------------------------------

### Create Bucket

Source: https://guide.ncloud-docs.com/docs/en/storage-storage-8-4

Example demonstrating how to create a new bucket using the AWS SDK for Javascript.

```APIDOC
## Create Bucket

This example shows how to create a new bucket in Object Storage using the AWS SDK for Javascript.

### Method

```javascript
S3.createBucket(params).promise()
```

### Parameters

#### Request Body

*   **Bucket** (string) - Required - The name of the bucket to create.
*   **CreateBucketConfiguration** (object) - Optional - Specifies the parameters for the bucket.

### Request Example

```javascript
const AWS = require('aws-sdk');

const endpoint = new AWS.Endpoint('https://kr.object.ncloudstorage.com');
const region = 'kr-standard';
const access_key = 'ACCESS_KEY'; // Replace with your ACCESS_KEY
const secret_key = 'SECRET_KEY'; // Replace with your SECRET_KEY

const S3 = new AWS.S3({
    endpoint,
    region,
    credentials: {
        accessKeyId : access_key,
        secretAccessKey: secret_key
    }
});

const bucket_name = 'sample-bucket'; // Replace with your desired bucket name

(async () => {
    await S3.createBucket({
        Bucket: bucket_name,
        CreateBucketConfiguration: {}
    }).promise()
    console.log(`Bucket '${bucket_name}' created successfully.`);
})();
```

### Response

#### Success Response (200)

Upon successful creation, the SDK call resolves. The response body is typically empty for a successful `createBucket` operation.

#### Response Example

(No specific response body is returned on success for this operation.)
```

--------------------------------

### Get User Device ID - Kotlin and Java

Source: https://guide.ncloud-docs.com/docs/en/appsafer-android

Retrieve the unique device identifier for the user. This function may throw an AppSaferException. The return value is a String representing the device identifier. The example demonstrates accessing the user's device ID.

```kotlin
fun getUserDeviceId(): String
```

```java
String getUserDeviceId() throws AppSaferException;
```

```kotlin
val userId = AppSafer.INSTANCE.userDeviceId
```

```java
String userDeviceId = AppSafer.INSTANCE.getUserDeviceId();
```

--------------------------------

### View Bucket Lists

Source: https://guide.ncloud-docs.com/docs/en/storage-storage-8-4

Example demonstrating how to list all available buckets using the AWS SDK for Javascript.

```APIDOC
## View Bucket Lists

This example shows how to retrieve a list of all buckets associated with your account using the AWS SDK for Javascript.

### Method

```javascript
S3.listBuckets().promise()
```

### Parameters

This method does not require any parameters.

### Request Example

```javascript
const AWS = require('aws-sdk');

const endpoint = new AWS.Endpoint('https://kr.object.ncloudstorage.com');
const region = 'kr-standard';
const access_key = 'ACCESS_KEY'; // Replace with your ACCESS_KEY
const secret_key = 'SECRET_KEY'; // Replace with your SECRET_KEY

const S3 = new AWS.S3({
    endpoint: endpoint,
    region: region,
    credentials: {
        accessKeyId : access_key,
        secretAccessKey: secret_key
    }
});

(async () => {
    let { Buckets } = await S3.listBuckets().promise();
    console.log('Your buckets:');
    for(let bucket of Buckets) {
        console.log(bucket.Name);
    }
})();
```

### Response

#### Success Response (200)

*   **Buckets** (array) - An array of objects, where each object contains information about a bucket, including its Name and CreationDate.

#### Response Example

```json
{
    "Buckets": [
        {
            "Name": "sample-bucket-1",
            "CreationDate": "2023-01-01T10:00:00.000Z"
        },
        {
            "Name": "another-bucket",
            "CreationDate": "2023-02-15T14:30:00.000Z"
        }
    ],
    "Owner": {
        "DisplayName": "your-display-name",
        "ID": "your-owner-id"
    }
}
```
```

--------------------------------

### Set User Identifier for App Safer SDK

Source: https://guide.ncloud-docs.com/docs/en/appsafer-android

This API allows you to set a user identifier that will be included in logs transmitted to the App Safer server during reset or detection events. The code examples are provided for Kotlin and Java, with a note that this must be called before the start() function.

```Kotlin
@Throws(AppSaferException::class)
fun setUserId(userId: String)

```

```Java
void setUserId(String userId) throws AppSaferException;

```

```Kotlin
AppSafer.INSTANCE.userId = "ExampleUserId"

```

```Java
AppSafer.INSTANCE.setUserId("ExampleUserId");

```

--------------------------------

### Upload Files

Source: https://guide.ncloud-docs.com/docs/en/storage-storage-8-4

Example demonstrating how to upload files to a bucket, including creating folders and setting ACLs, using the AWS SDK for Javascript.

```APIDOC
## Upload Files

This example demonstrates how to upload files to a specified bucket. It includes steps for creating a folder (by putting an object with a trailing slash) and uploading a file with public-read access.

### Method

```javascript
S3.putObject(params).promise()
```

### Parameters

#### Request Body

*   **Bucket** (string) - Required - The name of the bucket where the object will be uploaded.
*   **Key** (string) - Required - The name of the object (file path within the bucket).
*   **ACL** (string) - Optional - Access Control List for the object. 'public-read' allows public access.
*   **Body** (ReadableStream or Buffer) - Required - The content of the file to upload. `fs.createReadStream` is used for uploading from a local file.

### Request Example

```javascript
const AWS = require('aws-sdk');
const fs = require('fs');
const endpoint = new AWS.Endpoint('https://kr.object.ncloudstorage.com');
const region = 'kr-standard';
const access_key = 'ACCESS_KEY'; // Replace with your ACCESS_KEY
const secret_key = 'SECRET_KEY'; // Replace with your SECRET_KEY

const S3 = new AWS.S3({
    endpoint: endpoint,
    region: region,
    credentials: {
        accessKeyId : access_key,
        secretAccessKey: secret_key
    }
});

const bucket_name = 'sample-bucket'; // Replace with your bucket name
const local_file_path = '/tmp/test.txt'; // Replace with the actual local file path

(async () => {

    // Ensure the local file exists before attempting to upload
    if (!fs.existsSync(local_file_path)) {
        fs.writeFileSync(local_file_path, 'This is a test file content.');
        console.log(`Created dummy file at ${local_file_path}`);
    }

    let object_name_folder = 'sample-folder/';
    // Create a folder-like structure by putting an object with a trailing slash
    try {
        await S3.putObject({
            Bucket: bucket_name,
            Key: object_name_folder
        }).promise();
        console.log(`Folder '${object_name_folder}' created or already exists.`);
    } catch (error) {
        console.error("Error creating folder:", error);
    }

    let object_name_file = 'sample-folder/sample-object.txt'; // Name for the uploaded file

    // Upload the file
    try {
        await S3.putObject({
            Bucket: bucket_name,
            Key: object_name_file,
            ACL: 'public-read', // Set ACL to public-read for public access
            Body: fs.createReadStream(local_file_path)
        }).promise();
        console.log(`File '${object_name_file}' uploaded successfully to bucket '${bucket_name}'.`);
    } catch (error) {
        console.error("Error uploading file:", error);
    }

})();
```

### Response

#### Success Response (200)

Upon successful upload, the SDK call resolves. The response includes details about the uploaded object, such as `ETag`, `VersionId`, and `Location`.

#### Response Example

```json
{
    "ETag": "\"a1b2c3d4e5f67890a1b2c3d4e5f67890\"",
    "VersionId": "some-version-id",
    "Location": "https://your-bucket-name.kr.object.ncloudstorage.com/sample-folder/sample-object.txt",
    "Bucket": "sample-bucket",
    "Key": "sample-folder/sample-object.txt",
    "πους": "public-read"
}
```
```

--------------------------------

### Set and Get CORS

Source: https://guide.ncloud-docs.com/docs/en/storage-storage-8-4

This example demonstrates how to configure Cross-Origin Resource Sharing (CORS) for an Ncloud Object Storage bucket, including setting CORS rules and retrieving them.

```APIDOC
## PUT / ?cors
## GET / ?cors

### Description
Configures and retrieves Cross-Origin Resource Sharing (CORS) settings for an Ncloud Object Storage bucket. The `putBucketCors` operation sets the CORS configuration, while `getBucketCors` retrieves the current configuration.

### Method
PUT (Set CORS), GET (Get CORS)

### Endpoint
- **Set CORS**: `/{bucket_name}?cors`
- **Get CORS**: `/{bucket_name}?cors`

### Parameters
#### Request Body (for PUT /?cors)
- **Bucket** (string) - Required - The name of the bucket to configure CORS for.
- **CORSConfiguration** (object) - Required - The CORS configuration details.
  - **CORSRules** (array) - Required - A list of CORS rules.
    - **AllowedHeaders** (array) - Required - Headers allowed in CORS requests.
    - **AllowedMethods** (array) - Required - HTTP methods allowed for CORS requests (e.g., 'GET', 'PUT').
    - **AllowedOrigins** (array) - Required - Origins allowed to make CORS requests.
    - **MaxAgeSeconds** (integer) - Optional - The maximum time in seconds that a preflight request can be cached.

### Request Example (Set CORS)
```json
{
  "Bucket": "sample-bucket",
  "CORSConfiguration": {
    "CORSRules": [
      {
        "AllowedHeaders": ["*"],
        "AllowedMethods": ["GET", "PUT"],
        "AllowedOrigins": ["*"],
        "MaxAgeSeconds": 3000
      }
    ]
  }
}
```

### Response
#### Success Response (200)
- **(for PUT /?cors)** - Indicates the CORS configuration was successfully updated.
- **(for GET /?cors)** - Returns the CORS configuration of the bucket.
  - **CORSConfiguration** (object) - The CORS configuration.
    - **CORSRules** (array) - The list of CORS rules.
      - **AllowedHeaders** (array) - Allowed headers.
      - **AllowedMethods** (array) - Allowed methods.
      - **AllowedOrigins** (array) - Allowed origins.
      - **MaxAgeSeconds** (integer) - Max age in seconds.

#### Response Example (Get CORS)
```json
{
  "CORSConfiguration": {
    "CORSRules": [
      {
        "AllowedHeaders": [
          "*"
        ],
        "AllowedMethods": [
          "GET",
          "PUT"
        ],
        "AllowedOrigins": [
          "*"
        ],
        "MaxAgeSeconds": 3000
      }
    ]
  }
}
```
```

--------------------------------

### Install Cloud Insight Agent on VM

Source: https://guide.ncloud-docs.com/docs/en/cloudinsight-howtomove

This command installs the Cloud Insight agent on a Virtual Machine. It navigates to the agent controller directory and executes the install_agent.bat script with the 'pub-classic' parameter. Ensure the agent_controller_windows folder exists and the script is accessible.

```bash
agent_controller_windows\install_agent.bat pub-classic
```

--------------------------------

### Create Bucket using AWS SDK for JavaScript

Source: https://guide.ncloud-docs.com/docs/en/storage-storage-8-4

Demonstrates how to create a new bucket in Object Storage using the AWS SDK for JavaScript. Requires configuration of endpoint, region, and credentials.

```javascript
const AWS = require('aws-sdk');

const endpoint = new AWS.Endpoint('https://kr.object.ncloudstorage.com');
const region = 'kr-standard';
const access_key = 'ACCESS_KEY';
const secret_key = 'SECRET_KEY';

const S3 = new AWS.S3({
    endpoint,
    region,
    credentials: {
        accessKeyId : access_key,
        secretAccessKey: secret_key
    }
});


const bucket_name = 'sample-bucket';


(async () => {

    await S3.createBucket({
        Bucket: bucket_name,
        CreateBucketConfiguration: {}
    }).promise()

})();

```

--------------------------------

### Example Output of Temporary Credentials

Source: https://guide.ncloud-docs.com/docs/en/external-access-signing-helper-cli

This is an example JSON output representing temporary credentials obtained from the Signing Helper CLI. It includes the access key, secret key, and timestamps for creation and expiration.

```json
{
  "accessKey": "ncp_iam_BPSRK...WoqKhg3",
  "keySecret": "ncp_iam_BPTR...ypJklM3QbK",
  "createTime": "2024-09-30T08:31:07Z",
  "expireTime": "2024-09-30T09:31:07Z"
}
```

--------------------------------

### Uninstall Monitoring Agent and Install Cloud Insight Agent using PowerShell

Source: https://guide.ncloud-docs.com/docs/en/cloudinsight-howtomove

This PowerShell script automates the process of uninstalling the Nsight Monitoring agent and installing the Cloud Insight agent. It handles service termination, scheduled task removal, and agent installation, including downloading necessary files and configuring the agent. Ensure PowerShell execution policy allows script execution.

```powershell
Function Uninstall_Nsight()
{
    # nsight uninstall
    if(Test-Path "C:\Program Files (x86)\NBP\NSight\uninst.exe") {
        Start-Process "C:\Program Files (x86)\NBP\NSight\uninst.exe" -PassThru -Verbose -NoNewWindow -Wait -ErrorAction Ignore
    }

    # Unregister - Nsight ScheduledTask
    if ($(Get-ScheduledTask -TaskName "nsight" -ErrorAction SilentlyContinue).TaskName -eq "nsight") {
        Unregister-ScheduledTask -TaskName "nsight" -Confirm:$False
    }
}



Function Install_CloudInsight()
{
    if(!(Test-Path "C:\Program Files (x86)\NBP\agent_controller_windows\agent.bat")) {
        #Performance Table Restore
        Start-Process "C:\Windows\SysWOW64\lodctr.exe" -ArgumentList "/R"
        Invoke-WebRequest -uri https://repo-nsight.ncloud.com/agent_controller_windows_ncp.zip | Out-Null

        # Install CloudInsight
        if ((Get-CimInstance -ClassName Win32_BIOS).Manufacturer -eq 'Xen') {
            $nsight_source = "https://repo-nsight.ncloud.com/agent_controller_windows_ncp.zip"
            $nsight_opt = "/pub-classic"
            $wget = "C:\Windows\System32\wget.exe"
        }

        else {
            $nsight_source = "https://repo-nsight.ncloud.com/agent_controller_windows_pub_bm.zip"
            $nsight_opt = "/classic"
            $wget = "C:\Windows\System32\GroupPolicy\Machine\Scripts\startup\wget.exe"
        }

        if(!(Test-Path "C:\Program Files (x86)\NBP")) {
            New-Item "C:\Program Files (x86)\NBP" -ItemType Directory
        }

        $sourceFile = "C:\Program Files (x86)\NBP\agent_controller_windows.zip"
        $targetFile = 'C:\Program Files (x86)\NBP'

        Start-Process $wget -NoNewWindow -PassThru -Wait -ArgumentList "$nsight_source -q -O \"$sourceFile\" --no-check-certificate"
        $file = Get-ChildItem -Path $sourceFile
        $shell = new-object -com shell.application
        $destination = $shell.Namespace($targetFile)
        $zip = $shell.NameSpace($file.FullName)
        foreach($item in $zip.items()) {
            $destination.copyhere($item, 0x14)
        }

        Set-Location "$targetFile\agent_controller_windows"
        Start-Process "C:\Program Files (x86)\NBP\agent_controller_windows\install_agent.bat" -ArgumentList $nsight_opt -passthru -wait
        Remove-Item -Path $sourceFile -ErrorAction Ignore
    }
}

Uninstall_Nsight
Install_CloudInsight

```

--------------------------------

### View Exact Run Commands using /proc/{pid}/cmdline - Shell

Source: https://guide.ncloud-docs.com/docs/en/cloudinsight-troubleshoot-metric

After obtaining the PID, this command allows you to view the exact run command used to start the process. It reads the cmdline file and replaces null bytes with spaces for readability. Replace {pid} with the actual process ID.

```Shell
cat /proc/{pid}/cmdline | tr '\000' '\040'
```

--------------------------------

### View Bucket Lists using AWS SDK for JavaScript

Source: https://guide.ncloud-docs.com/docs/en/storage-storage-8-4

Shows how to retrieve a list of all buckets in Object Storage using the AWS SDK for JavaScript. It iterates through the returned buckets and logs their names.

```javascript
const AWS = require('aws-sdk');

const endpoint = new AWS.Endpoint('https://kr.object.ncloudstorage.com');
const region = 'kr-standard';
const access_key = 'ACCESS_KEY';
const secret_key = 'SECRET_KEY';

const S3 = new AWS.S3({
    endpoint: endpoint,
    region: region,
    credentials: {
        accessKeyId : access_key,
        secretAccessKey: secret_key
    }
});

(async () => {

    let { Buckets } = await S3.listBuckets().promise();

    for(let bucket of Buckets) {
        console.log(bucket.Name);
    }

})();

```
Tokens:
Raw