Ksyun Documentation

https://docs.ksyun.com/documents
Admin
Comprehensive documentation for Ksyun cloud services platform covering compute, networking, storage,...
Tokens:17,083,138
Snippets:26,330
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Installation Commands

Source: https://docs.ksyun.com/documents/37169?type=3

Examples of how to run the install script for specific operating system versions.

```bash
./install.sh debian 8
```

```bash
./install.sh centos 6
```

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

### Installation Guides

Source: https://docs.ksyun.com/documents/1572?preview=1&type=6

Guides for installing various software and drivers on cloud servers.

```APIDOC
## Installation Guides

### Description
Provides guides for installing essential software and drivers.

### Category: Installation Guides

#### Install CUDA Driver Guide

##### Description
Step-by-step guide for installing NVIDIA CUDA drivers.

##### Method
GET

##### Endpoint
/guides/cuda-driver-installation

#### Install cuDNN and NCCL Guide

##### Description
Guide for installing cuDNN and NCCL libraries for deep learning.

##### Method
GET

##### Endpoint
/guides/cudnn-nccl-installation

#### Install CAFFE Guide

##### Description
Guide for installing the CAFFE deep learning framework.

##### Method
GET

##### Endpoint
/guides/caffe-installation

#### Install TensorFlow Guide

##### Description
Guide for installing the TensorFlow machine learning framework.

##### Method
GET

##### Endpoint
/guides/tensorflow-installation

```

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

### Go SDK - Quick Start

Source: https://docs.ksyun.com/documents/40767?type=3

A quick start guide for using the KS3 SDK for Go.

```APIDOC
## Quick Start (Go)

### Description
A concise guide to help developers get started quickly with the KS3 SDK for Go, demonstrating basic usage patterns.
```

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

### Install Helm3 Application Request Example

Source: https://docs.ksyun.com/documents/7983?type=6

This example demonstrates how to make a POST request to install a Helm3 application using the KCE API. Ensure all required parameters are correctly formatted and included in the request body.

```bash
curl -X POST   \
'http://kce.api.ksyun.com/?Action=InstallRelease&Version=2019-08-06'   \
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'   \
-H 'cache-control: no-cache'   \
-H 'content-type: application/x-www-form-urlencoded'   \
-H 'host: kce.api.ksyun.com'   \
-H 'x-amz-date: 20170720T022802Z'  \
-d 'ClusterId=xxx&Namespace=xxx&ReleaseName=xxx&ChartSource=xxx&ChartNamespace=xxx&ChartName=xxx&ChartVersion=xxx&ChartUrl=xxx&ChartRepoType=xxx&ChartRepoUsername=xxx&ChartRepoPassword=xxx&Values=xxx'
```

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

### GET Request Example

Source: https://docs.ksyun.com/documents/239

Use this example for making a GET request to retrieve bandwidth data. Ensure to set the correct Host, X-Amz-Date, Authorization, x-action, and x-version headers.

```http
GET /2016-09-01/statistics/GetProvinceAndIspBandwidthData?StartTime=2019-08-21T16%3A00%2B0800&EndTime=2019-08-22T18%3A00%2B0800&CdnType=file&DomainIds=&Provinces=&Isps=&ResultType=1&Granularity=1440 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetProvinceAndIspBandwidthData
x-version: 2016-09-01
```

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

### Install Go SDK (Go)

Source: https://docs.ksyun.com/documents/40487

Install the KSYUN Go SDK using the go get command. This command fetches and installs the SDK package from its GitHub repository.

```bash
go get github.com/ks3sdklib/aws-sdk-go
```

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

### Create File Share Service - GET Request Example

Source: https://docs.ksyun.com/documents/44190?type=3

Use this GET request example to create a file share service. Ensure all required parameters are correctly formatted.

```http
http://kenc.api.ksyun.com/?Action=CreateSimpleFileShareService&Version=2020-08-01&NamespaceID=default-20000**897&InstanceName=test-sfss-001&BillType=PostPaid&EdgeNodeId=taizmp01&Protocol=NFS&StorageCategory=standard&StorageCapacity=2048&VpcId=vpc-xxx&SubnetId=sw-xxx
```

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

### Java SDK - Quick Start

Source: https://docs.ksyun.com/documents/40767?type=3

A quick start guide for using the KS3 SDK for Java.

```APIDOC
## Quick Start (Java)

### Description
A concise guide to get started with the KS3 SDK for Java, covering basic operations like creating a client and performing simple uploads or downloads.
```

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

### Start kasmVNC Remote Desktop Service

Source: https://docs.ksyun.com/documents/44457?type=3

This command starts the kasmVNC remote desktop service, using a Jupyter environment as an example. This is typically executed within a containerized setup.

```bash
/docker_config/entrypoint.sh
```

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

### Get Preset List Example

Source: https://docs.ksyun.com/documents/2364?type=3

This example demonstrates a successful response when retrieving a list of presets.

```APIDOC
## Get Preset List

### Description
Retrieves a list of available presets.

### Method
GET

### Endpoint
/presets

### Response
#### Success Response (200)
- **PresetList** (array) - A list of preset objects.
  - **Preset** (string) - The identifier for the preset.
  - **App** (string) - The application associated with the preset.
  - **FmtNum** (string) - The format number.
  - **Description** (string) - A description of the preset.
  - **CreateTime** (string) - The timestamp when the preset was created.
  - **UpdateTime** (string) - The timestamp when the preset was last updated.
- **ErrNum** (integer) - The error number (0 for success).
- **ErrMsg** (string) - The error message (e.g., "success").

### Response Example
```json
{
    "PresetList": [
        {
            "Preset": "555",
            "App": "xxxxx",
            "FmtNum": "3",
            "Description": "descssss:555",
            "CreateTime": "2017-05-06 12:09:08",
            "UpdateTime": "2017-05-06 16:19:54"
        },
        {
            "Preset": "666",
            "App": "xxxxx",
            "FmtNum": "2",
            "Description": "testpreset",
            "CreateTime": "2017-05-06 16:07:21",
            "UpdateTime": ""
        },
        {
            "Preset": "testpreset1",
            "App": "xxxxx",
            "FmtNum": "2",
            "Description": "ttttt",
            "CreateTime": "2017-05-06 16:07:56",
            "UpdateTime": "2017-05-06 16:24:50"
        }
    ],
    "ErrNum": 0,
    "ErrMsg": "success"
}
```
```

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

### Start Instance Database Audit API Request

Source: https://docs.ksyun.com/documents/41005?type=3

This is an example of a GET request to start the instance database audit feature. Ensure you replace '{{region}}' with your specific region and '4d97f65f-5603-4373-b870-48a280ecc464' with your actual DBInstanceIdentifier.

```http
http://krds.{{region}}.api.ksyun.com/?Action=StartAudit&Version=2016-07-01&DBInstanceIdentifier=4d97f65f-5603-4373-b870-48a280ecc464

```

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

### Go SDK - Installation and Initialization

Source: https://docs.ksyun.com/documents/44574

Instructions for installing and initializing the Go SDK.

```APIDOC
## Installation (Go)
### Description
Provides instructions on how to install the KS3 Go SDK.
### Method
N/A (Installation command)
### Endpoint
N/A

## Initialization (Go)
### Description
Guides on how to initialize the KS3 Go SDK client.
### Method
N/A (SDK method)
### Endpoint
N/A
```

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

### SDK Initialization and Configuration

Source: https://docs.ksyun.com/documents/2414?type=3

Instructions for setting up the SDK, including obtaining AK/SK credentials, configuring the credentials file, and installing the SDK using Composer.

```APIDOC
## Initialization

### AK/SK Configuration
Create the following file and populate it with your Access Key (ak) and Secret Key (sk):

```
mkdir ~/.ksyun && vi ~/.ksyun/config
```

**config file content:**
```json
{
    "ak":"********************",
    "sk":"****************************************"
}
```

### Composer Installation
Install the SDK using Composer:

```bash
mkdir test && cd test
composer require kscsdk/ksyun_sdk
```

To use the latest version, modify your `composer.json` file:

```json
{
	"require": {
    	"kscsdk/ksyun_sdk": "dev-master"
	}
}
```

Then run the update command:

```bash
composer update
```

### Debug Demo
Run a demo to test the installation:

```bash
cp vendor/kscsdk/ksyun_sdk/examples/demo_Kvs.php .
php demo_Kvs.php GetPresetList
```
```

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

### Start OpenClaw Onboarding

Source: https://docs.ksyun.com/documents/45243?type=3

Initiate the OpenClaw configuration process by running the onboard command. This command guides you through the initial setup, including security notices and basic configurations.

```bash
openclaw onboard
```

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

### Request Example 3: Enable Accelerator for Specific Prefixes

Source: https://docs.ksyun.com/documents/45325?type=3

This example configures the accelerator for specific prefixes ('prefix1/' and 'prefix2/'). It also shows how to enable sync warm-up for 'prefix1/' and disable it for 'prefix2/'.

```http
PUT /?dataAccelerator HTTP/1.1 
Host: bucketname.ks3-data-acc-cn-beijing-e-internal.ksyuncs.com
Date: Wed, 14 May 2014 02:11:21 GMT
Authorization: authorization string
Content-Length: yyy
Content-type: application/xml 

<DataAcceleratorConfiguration>
    <AvailableZone>cn-beijing-e</AvailableZone>
    <Quota>200</Quota>
    <AcceleratePaths>
        <Path>
            <Prefix>prefix1/</Prefix>
            <SyncWarmup>true</SyncWarmup>
        </Path>
        <Path>
            <Prefix>prefix2/</Prefix>
            <SyncWarmup>false</SyncWarmup>
        </Path>
    </AcceleratePaths>
</DataAcceleratorConfiguration>
```

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

### GET Request Example

Source: https://docs.ksyun.com/documents/42251?type=3

Example of making a GET request to the /http-invoke endpoint.

```APIDOC
## GET /http-invoke

### Description
Retrieves resources from the /http-invoke endpoint.

### Method
GET

### Endpoint
http://127.0.0.1:80880/http-invoke

### Request Example
```bash
curl -X GET http://127.0.0.1:80880/http-invoke
```
```

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

### GET Object Example

Source: https://docs.ksyun.com/documents/2321

Example of calculating the signature for a GET Object request.

```APIDOC
## GET Object

### Description
Retrieves an object from a specified bucket.

### Method
GET

### Endpoint
/examplebucket/1.txt

### Request Example
```
GET /1.txt HTTP/1.1
Host: examplebucket.ks3-cn-beijing.ksyuncs.com
Date: Tue, 30 Nov 2021 11:06:30 GMT
Authorization: KSS AKLTA6qLnuowT6KzKybUQNC0Tw:i+PiOc1sxIe6yjZwyi4/+kxmXs8=
```

### Response Example
(Success response depends on the object content)

### Note
CanonicalizedResource includes the bucket name, which is not present in the HTTP request URI because the bucket name is specified in the Host request header.
```

```APIDOC
```python
import base64
import hmac
from hashlib import sha1
h = hmac.new("OCd5HzFDU1YDUG6eTHASvdt1RRn5bqKNKdl8JxuFrYne+bazX7gmoYUG73XjJ/d2sg==", "GET\n\n\nTue, 30 Nov 2021 11:06:30 GMT\n/examplebucket/photos/1.jpg", sha1)
Signature = base64.encodestring(h.digest()).strip()
```
```

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

### Download File Example (Go)

Source: https://docs.ksyun.com/documents/41276?type=3

Use this snippet to download a standard file. Ensure you replace placeholders like <AccessKeyID>, <SecretAccessKey>, <bucket_name>, and <object_key> with your actual credentials and object details.

```Go
package main

import (
    "fmt"
    "github.com/ks3sdklib/aws-sdk-go/aws"
    "github.com/ks3sdklib/aws-sdk-go/aws/credentials"
    "github.com/ks3sdklib/aws-sdk-go/service/s3"
)

func main() {
    // 创建访问凭证，请将<AccessKeyID>与<SecretAccessKey>替换成真正的值
    cre := credentials.NewStaticCredentials("<AccessKeyID>", "<SecretAccessKey>", "")
    // 创建S3Client，更多配置项请查看Go-SDK初始化文档
    client := s3.New(&aws.Config{
       Credentials: cre,
       Region:      "BEIJING",
       Endpoint:    "ks3-cn-beijing.ksyuncs.com",
    })
    // 填写存储空间名称
    bucket := "<bucket_name>"
    // 填写对象的key
    key := "<object_key>"
    // 下载文件
    resp, err := client.GetObject(&s3.GetObjectInput{
       Bucket: aws.String(bucket),
       Key:    aws.String(key),
    })
    if err != nil {
       panic(err)
    }
    // 读取返回结果中body的前1024个字节
    buffer := make([]byte, 1024)
    n, err := resp.Body.Read(buffer)
    if err != nil {
       panic(err)
    }
    fmt.Printf("结果：%s", buffer[:n])
}
```

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

### DescribeClientInstallInfo Request Example

Source: https://docs.ksyun.com/documents/44861

This is an example of an HTTP request to the DescribeClientInstallInfo API. Ensure you replace placeholder values with your actual parameters.

```http
http://kpfs.api.ksyun.com?FileSystemId=301c1d57a1b14aadbb34ffccbf25369e&Action=DescribeClientInstallInfo&Version=2024-09-30
```

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

### Request Example 1: Enable Accelerator for Entire Bucket (No Sync Warm-up)

Source: https://docs.ksyun.com/documents/45325?type=3

This example shows how to enable the accelerator for the entire bucket without enabling sync warm-up. The `AcceleratePaths` element is omitted.

```http
PUT /?dataAccelerator HTTP/1.1 
Host: bucketname.ks3-data-acc-cn-beijing-e-internal.ksyuncs.com
Date: Wed, 14 May 2014 02:11:21 GMT
Authorization: authorization string
Content-Length: yyy
Content-type: application/xml 

<DataAcceleratorConfiguration>
    <AvailableZone>cn-beijing-e</AvailableZone>
    <Quota>200</Quota>
</DataAcceleratorConfiguration>
```

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

### DescribeClientInstallInfo Response Example

Source: https://docs.ksyun.com/documents/44861

This is an example of a successful response from the DescribeClientInstallInfo API. It includes the RequestId, ClusterDataIP, and details about the client installation packages.

```json
{
 "RequestId": "ea82d72e-0169-4970-8beb-92d3a10964d7",
  "ClusterDataIP":'10.0.0.1',
  "Data": [
        {
            "DownloadUrl": "https://nas-s-nx.ks3-cn-ningxia-internal.ksyuncs.com/posix-client/v412-100222/ofs-client-ubuntu22.04.3-5.15.0-88-generic-X86-MLX5.8_3.0-330000-000-UStor_ofs4.1.2_930_6d76c8f47f17_20250222_153609-53-1.tar.xz",
            "OsVersion": "Ubuntu22.04",
            "KernelVersion":"5.15.0-88",
            "NicDriver":"5.8-3.0.7.0-LTS"
        }
    ]
}
```

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

### Request Example (GET)

Source: https://docs.ksyun.com/documents/40308

Example of a GET request including common and query parameters for API authentication.

```APIDOC
## Request Example (GET)

```
GET /?Action=ListUsers&Version=2015-11-01 HTTP/1.1
Host: iam.api.ksyun.com
X-Amz-Date: 20160914T114902Z
Authorization: AWS4-HMAC-SHA256 Credential=AKLTGo0pHK-EQWiDZWTSBSll2Q/20160914/cn-beijing-6/iam/aws4_request, SignedHeaders=host;x-amz-date, Signature=88f6284257863dedfc350da05d19d07f76cca622e93b829f5ce26c1a75d3da39
```
```

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

### Example GET Bucket CORS Request

Source: https://docs.ksyun.com/documents/42311

An example of a GET Bucket CORS request, including Host, Date, and Authorization headers.

```http
GET /?cors HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyun.com
Date: Wed, 24 Dec 2014 03:08:04 GMT
Authorization: authorization string


```

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

### Example Configuration Parameters

Source: https://docs.ksyun.com/documents/43711

Illustrates sample values for source and destination prefixes, and source type, used in determining the object key for migrated files.

```text
srcPrefix=files/
dstPrefix=upload/
srcType=ks3
```

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

### GET Bucket Quota Request Example

Source: https://docs.ksyun.com/documents/44897

An example of a GET Bucket Quota request, including a sample host, date, and authorization string.

```http
GET /?quota HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Date: Wed, 01 Mar 2016 12:00:00 GMT
Authorization: authorization string
```

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

### GET Request Example

Source: https://docs.ksyun.com/documents/40297

Illustrates how to structure a GET request with business and common parameters in the URL query.

```http
https://{service}.api.ksyun.com/?{业务参数}&{公共参数}
```

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

### Request Example 2: Enable Accelerator for Entire Bucket (With Sync Warm-up)

Source: https://docs.ksyun.com/documents/45325?type=3

This example demonstrates enabling the accelerator for the entire bucket and activating sync warm-up. The `SyncWarmup` tag is set to `true` within `AcceleratePaths`.

```http
PUT /?dataAccelerator HTTP/1.1 
Host: bucketname.ks3-data-acc-cn-beijing-e-internal.ksyuncs.com
Date: Wed, 14 May 2014 02:11:21 GMT
Authorization: authorization string
Content-Length: yyy
Content-type: application/xml 

<DataAcceleratorConfiguration>
    <AvailableZone>cn-beijing-e</AvailableZone>
    <Quota>200</Quota>
    <AcceleratePaths>
        <Path>
            <SyncWarmup>true</SyncWarmup>
        </Path>
    </AcceleratePaths>
</DataAcceleratorConfiguration>
```

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

### Example GET Request for Job Information

Source: https://docs.ksyun.com/documents/44575

This is an example of an HTTP GET request to retrieve the details of a specific batch job using its jobId.

```http
GET /?jobs&jobId=184ce261-18af-5e3d-3e30-253723cfd937 HTTP/1.1
Host: ks3-cn-beijing.ksyuncs.com
Date: Wed, 01 Mar 2025 12:00:00 GMT
Authorization: authorization string
```

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

### GET Bucket Lifecycle Request Example

Source: https://docs.ksyun.com/documents/42295

An example of a GET Bucket Lifecycle request, demonstrating the required headers such as Host, Date, and Authorization.

```http
GET /?lifecycle HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Date: Wed, 01 Mar 2016 12:00:00 GMT
Authorization: authorization string
```

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

### GET Bucket Location Request Example

Source: https://docs.ksyun.com/documents/42286?type=3

An example of a GET Bucket Location request. This includes a sample Host header and Authorization string.

```HTTP
GET /?location HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Date: Wed, 01 Mar 2010 12:00:00 GMT
Authorization: authorization string

```

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

### Go SDK - Installation and Initialization

Source: https://docs.ksyun.com/documents/43784?type=3

Instructions for installing and initializing the KS3 Go SDK.

```APIDOC
## Installation (Go)

### Description
Installs the KS3 Go SDK using the Go module system.

### Command
`go get github.com/ks3sdk/ks3-go-sdk`

## Initialization (Go)

### Description
Initializes the KS3 client with your credentials and endpoint.

### Code Example
```go
import (
	"github.com/ks3sdk/ks3-go-sdk/ks3"
)

func main() {
	client, err := ks3.New("YOUR_ACCESS_KEY_ID", "YOUR_SECRET_ACCESS_KEY", "YOUR_ENDPOINT")
	if err != nil {
		panic(err)
	}
	// Use the client for operations
}
```
```

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

### GET Bucket Location Request Example

Source: https://docs.ksyun.com/documents/42286

An example of a GET Bucket Location request, including a sample Host, Date, and Authorization string.

```HTTP
GET /?location HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Date: Wed, 01 Mar 2010 12:00:00 GMT
Authorization: authorization string


```

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

### Go SDK - Configuration Practices

Source: https://docs.ksyun.com/documents/44518?type=3

Practical examples for configuring the Go SDK.

```APIDOC
## Set Retry Strategy and Conditions (Go)

### Description
Configures the retry mechanism, including the strategy and conditions under which retries are performed, for the Go SDK.

## Set Log Output (Go)

### Description
Configures the logging output for the Go SDK, specifying where and how logs should be recorded.

## Set Custom Request Headers and Parameters (Go)

### Description
Allows setting custom HTTP headers and request parameters for requests made by the Go SDK.

## Set DNS Cache (Go)

### Description
Configures the DNS caching behavior for the Go SDK to improve performance.
```

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

### Get Quota Application Request Example

Source: https://docs.ksyun.com/documents/40136?type=3

Example of a GET request to retrieve quota application details. Ensure to include the ApplyId parameter.

```http
https://quota.api.ksyun.com/?Action=GetQuotaApplication&Version=2021-05-19&ApplyId=lFWOQjRVQrFFFq1g33A
```

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

### Create Instance Account (With Description and Privileges)

Source: https://docs.ksyun.com/documents/40980?type=3

This example demonstrates creating a database account with a description and specific database privileges. The InstanceAccountPrivileges field accepts a list of objects, each defining a database name and the privilege level (ReadOnly, ReadWrite, DDLOnly, DMLOnly).

```json
//新建账号时同时添加描述和权限
 
//request url:
http://krds.{{region}}.api.ksyun.com/?Action=CreateInstanceAccountAction&Version=2016-07-01
  
//request body:
{
    "DBInstanceIdentifier": "4d97f65f-5603-4373-b870-48a280ecc464",
    "InstanceAccountName": "kingsoft_test2",
    "InstanceAccountPassword": "Testkingsoft1",
    "InstanceAccountDescription": "kingsoft_test_demo",
    "InstanceAccountPrivileges": [
        {
            "InstanceDatabaseName": "kingsoft_002",
            "Privilege": "ReadOnly"
        },
        {
            "InstanceDatabaseName": "kingsoft_003",
            "Privilege": "ReadWrite"
        },
        {
            "InstanceDatabaseName": "kingsoft_004",
            "Privilege": "DDLOnly"
        },
        {
            "InstanceDatabaseName": "kingsoft_005",
            "Privilege": "DMLOnly"
        }
    ]
}
```

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

### GET Request Example for GetFlowDataByDir

Source: https://docs.ksyun.com/documents/246?type=3

Use this example for making a GET request to retrieve flow data. Ensure all parameters are correctly formatted.

```http
GET /2016-09-01/statistics/GetFlowDataByDir?StartTime=2017-02-23T10%3a00%2b0800&EndTime=2017-02-23T10%3a21%2b0800&Regions&ResultType=1&granularity=10&DomainId=2D09NMS&Dirs=/ 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
X-Action: GetFlowDataByDir
X-Version: 2016-09-01

```

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

### Example Mount Command with Credentials

Source: https://docs.ksyun.com/documents/43899

An example of mounting a file system, showing the interactive prompts for Token, Secret ID, and Secret Key.

```bash
sudo /usr/local/bin/juicefs mount mytest /localfolder
Token for mytest：********
Secret ID for ks3 bucket 2000176024-mytest-snx187g2：********
Secret Key  for ks3 bucket 2000176024-mytest-snx187g2：********
```

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

### Example GET Request for Decompress Policy

Source: https://docs.ksyun.com/documents/43738

An example of a GET request to retrieve the decompress policy. Replace placeholders with your actual bucket and authorization details.

```http
GET /?decompresspolicy HTTP/1.1
Host: bucketname.ks3-cn-beijing.ksyuncs.com 
Authorization: authorization string
Content-Type: application/json
Content-Length: 497
Date: Tue, 21 Jul 2023 15:38:30 GMT
```

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

### GET Object Tagging Request Example

Source: https://docs.ksyun.com/documents/42340

An example of a GET Object Tagging request, including the object key, host, date, and authorization string.

```http
GET /my-image.jpg ?tagging HTTP 1.1
Host:ks3-example.ks3-cn-beijing.ksyun.com
Date: Fri, 19 Jan 2020 11:40:22 GMT
Authorization: authorization string

```

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

### GET Bucket Logging Request Example

Source: https://docs.ksyun.com/documents/42306

An example of a GET Bucket Logging request, including necessary headers like Host, Date, and Authorization.

```http
GET /?logging HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Date: Wed, 25 Nov 2009 12:00:00 GMT
Authorization: authorization string

```

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

### SDK for PHP - Initialization and Basic Usage

Source: https://docs.ksyun.com/documents/2414

This snippet covers the installation of the SDK using Composer, configuration of AK/SK credentials, and a basic example of calling the GetPresetList API.

```APIDOC
## Initialization

**ak/sk configuration**

Create the configuration file `~/.ksyun/config` with your AK/SK:
```
mkdir ~/.ksyun && vi ~/.ksyun/config
```

```json
{
    "ak":"********************",
    "sk":"****************************************"
}
```

**Composer Installation**

Install the SDK using Composer:
```bash
mkdir test && cd test
composer require kscsdk/ksyun_sdk
```

To use the latest version, update `composer.json` and run `composer update`.

**Debugging Demo**

Run the demo script:
```bash
cp vendor/kscsdk/ksyun_sdk/examples/demo_Kvs.php .
php demo_Kvs.php GetPresetList
```

**Basic API Call Example**

```php
<?php
require('vendor/autoload.php');
use Ksyun\Service\Kvs;
$response = Kvs::getInstance()->request('GetPresetList');
echo $response->getBody();
?>
```
```

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

### Install Python SDK using Git

Source: https://docs.ksyun.com/documents/2415

Clone the SDK repository and install it locally using setup.py. This method is useful for development or when direct access to the source is needed.

```bash
git clone https://github.com/KscSDK/ksc-sdk-python.git
cd ksc-sdk-python
python setup.py install
```

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

### GetFlowHitRateData API GET Request Example

Source: https://docs.ksyun.com/documents/39054

Example of a GET request to the GetFlowHitRateData API. Ensure to replace placeholder values for Host, X-Amz-Date, and Authorization.

```http
GET /2020-06-30/statistics/GetFlowHitRateData?StartTime=2020-09-01T08%3a00%2b0800&EndTime=2020-09-01T08%3a05%2b0800&Interval=5&CdnType=video&ResultType=
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetFlowHitRateData
x-version: 2020-06-30


```

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

### Create SQLServer Instance

Source: https://docs.ksyun.com/documents/27620?type=3

This example demonstrates the creation of a SQLServer instance.

```APIDOC
## Create SQLServer Instance

### Description
Provides an SqlServer instance resource. A DB instance is an isolated database environment in the cloud. A DB instance can contain multiple user-created databases.

### Arguments
- **output_file** (Required) - Filename to store the returned content.
- **dbinstanceclass** (Required) - Database instance class, e.g., `db.ram.2|db.disk.20`.
- **dbinstancename** (Required) - Instance name.
- **dbinstancetype** (Required) - Instance type, supports `HRDS_SS`.
- **engine** (Required) - Database engine name, must be `SQLServer`.
- **engineversion** (Required) - Database engine version, e.g., `2008r2`.
- **masterusername** (Required) - Master username.
- **masteruserpassword** (Required) - Master user password.
- **vpc_id** (Required) - Virtual private network ID.
- **subnet_id** (Required) - Subnet ID.
- **billtype** (Required) - Billing type: `DAY` (daily billing).
```

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

### GET Request Example with Authorization Header

Source: https://docs.ksyun.com/documents/194?type=3

An example of a GET request to the CDN API, including the necessary headers and the Authorization header with the calculated signature.

```http
GET /2016-09-01/domain/GetDomainConfigs?DomainId=2D08BTW HTTP/1.1
User-Agent: python-requests/2.23.0
accept-encoding: gzip
accept: */*
connection: keep-alive
host: cdn.api.ksyun.com
x-action: GetDomainConfigs
x-version: 2016-09-01
x-amz-date: 20210726T111902Z
Authorization: AWS4-HMAC-SHA256 Credential=LVLBPx7VDwlJRQGkpODXBCCruZ/20210726/cn-beijing-6/cdn/aws4_request, SignedHeaders=host;x-amz-date, Signature=cef04283a6cd6babf04x7f1ab132xq0ac7cd7q81537beqedbd4d9495f8a8axe3

```

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

### GET Request Signed URL Example

Source: https://docs.ksyun.com/documents/6890

Example of a pre-signed URL for a GET request, including all necessary signature parameters and an expiration time of 7 days.

```text
GET
http://examplebucket.ks3-cn-beijing.ksyuncs.com/1.txt
?X-Kss-Algorithm=KSS4-HMAC-SHA256
&X-Kss-Credential=AKLTA6qLnuowT6KzKybUQNC0Tw%2F20211130%2FBEIJING%2Fks3%2Fkss4_request
&X-Kss-Date=20211130T075703Z
&X-Kss-Expires=604800
&X-Kss-SignedHeaders=host
&X-Kss-Signature=<signature-value>
```

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

### Install Ksyun Python SDK from Source

Source: https://docs.ksyun.com/documents/262

Install the Ksyun API Python SDK by downloading the source code from GitHub and running the setup script.

```bash
cd kingsoftcloud-sdk-python
python setup.py install
```

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

### Example: Initial cp Command for Uploading a Folder

Source: https://docs.ksyun.com/documents/44510?type=3

This example shows the initial `cp` command used to upload a folder. It demonstrates how a task ID is generated upon completion, which can then be used to recover failed uploads.

```bash
./ks3util cp /root/test/100_files/ ks3://samplebucket/100_files/ -r -f
```

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

### GET Object Tagging Response Example

Source: https://docs.ksyun.com/documents/42340

Example of a successful response from the GET Object Tagging API, showing the object's tags in XML format.

```xml
HTTP/1.1 200 OK
Date: Fri, 19 Jan 2020 11:40:22 GMT
Content-Type: application/xml
Connection: keep-alive
x-kss-request-id: f87dgt80hfsobs784dib5no5lkaqhf4n
Server: KS3
<Tagging>
    <TagSet>
        <Tag>
            <Key>age</Key>
            <Value>18</Value>
        </Tag>
        <Tag>
            <Key>name</Key>
            <Value>xiaoming</Value>
        </Tag>
    </TagSet>
</Tagging>

```

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

### Install POSIX Client (Auto Mount)

Source: https://docs.ksyun.com/documents/43899

Navigate to the client directory and run the install script with the storage node IPs. The --force=1 option can be used to override version checks.

```bash
cd client
./install.py --ips=xxxxx --force=1
```

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

### Example GET Bucket Policy Request

Source: https://docs.ksyun.com/documents/42299

An example of a GET request to retrieve a bucket policy. This includes a sample Host header, Authorization string, and Date.

```http
GET /?policy HTTP/1.1
Host: ks3-example.ks3-cn-beijing.ksyuncs.com
Authorization: authorization string
Date: Tue, 19 Jul 2016 09:12:54 GMT

```

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

### Example API Response for Starting Audit

Source: https://docs.ksyun.com/documents/41005?type=3

This is an example of a successful JSON response when starting the instance database audit feature. It includes a RequestId for tracking the operation.

```json
{
    "RequestId": "71583587-9f96-4c3b-83a4-15f51d985b45"
}

```

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

### Example: Mount KS3 bucket

Source: https://docs.ksyun.com/documents/42566?type=3

An example demonstrating how to mount the 'test-auto-bucket' KS3 bucket to the '/mnt/' directory.

```bash
goofys --subdomain --endpoint=https://ks3-cn-beijing.ksyuncs.com test-auto-bucket /mnt/  //将test-auto-bucket存储桶挂载到/mnt/目录下

```

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

### GET Request Example for GetProvinceAndIspHttpCodeData

Source: https://docs.ksyun.com/documents/242?type=3

This example demonstrates how to call the GetProvinceAndIspHttpCodeData API using the GET method. Ensure to replace placeholder values with your actual parameters.

```http
GET /2016-09-01/statistics/GetProvinceAndIspHttpCodeData?StartTime=2016-07-31T21:14%2b0800&EndTime=2016-07-31T21:16%2b0800&CdnType=video&DomainIds=2D09QWA&Provinces=liaoning&Isps=UN&ResultType=1&HitType=reqhitrate,flowhitrate 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetProvinceAndIspHttpCodeData
x-version: 2016-09-01


```

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

### Create Bucket

Source: https://docs.ksyun.com/documents/2328?type=3

This example shows how to create a new bucket.

```APIDOC
## Create Bucket

### Description
Creates a new bucket. Bucket names must be globally unique.

### Method
N/A (SDK Method)

### Endpoint
N/A

### Parameters
None (bucketName is typically a member variable or passed during initialization)

### Request Example
```csharp
private static bool createBucket()
{
    // Create Bucket
    try
    {
        Console.WriteLine("--- Create Bucket: ---");
        Console.WriteLine("Bucket Name: " + bucketName);
        Bucket bucket = ks3Client.createBucket(bucketName);
        Console.WriteLine("Success.");
        Console.WriteLine("----------------------\\n");
    }
    catch(System.Exception e)
    {
        Console.WriteLine("Create Bucket Fail! " + e.ToString());
        return false;
    }
    return true;
}
```

### Response
#### Success Response
Returns a `Bucket` object upon successful creation.

#### Error Handling
If a 409 conflict error occurs, it indicates that the bucket name is already in use.
```

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

### GET Object Example

Source: https://docs.ksyun.com/documents/2321?type=3

Provides an example of calculating the V2 signature for a GET Object request, including the StringToSign and a Python code snippet for signature generation.

```APIDOC
## GET Object

### Description
Retrieves an object from a bucket using V2 signature.

### Method
GET

### Endpoint
/1.txt

### Request Example
```
GET /1.txt HTTP/1.1
Host: examplebucket.ks3-cn-beijing.ksyuncs.com
Date: Tue, 30 Nov 2021 11:06:30 GMT
Authorization: KSS AKLTA6qLnuowT6KzKybUQNC0Tw:i+PiOc1sxIe6yjZwyi4/+kxmXs8=
```

### StringToSign Example
```
GET\n\n\nTue, 30 Nov 2021 11:06:30 GMT\n/examplebucket/1.txt
```

### Code Example (Python)
```python
import base64
import hmac
from hashlib import sha1
h = hmac.new("OCd5HzFDU1YDUG6eTHASvdt1RRn5bqKNKdl8JxuFrYne+bazX7gmoYUG73XjJ/d2sg==", "GET\n\n\nTue, 30 Nov 2021 11:06:30 GMT\n/examplebucket/1.txt", sha1)
Signature = base64.encodestring(h.digest()).strip()
```
```

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

### Go SDK - Installation

Source: https://docs.ksyun.com/documents/6321?type=3

Instructions for installing the KS3 SDK for Go.

```APIDOC
## Installation (Go)

### Description
Provides guidance on how to install the KS3 SDK for Go in your Go development environment.
```

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

### GetHitRateDetailedData GET Request Example

Source: https://docs.ksyun.com/documents/227?type=3

Example of how to call the GetHitRateDetailedData API using the GET method. Ensure to replace placeholder values for Host, X-Amz-Date, and Authorization.

```http
GET /2016-09-01/statistics/GetHitRateDetailedData?StartTime=2016-07-31T21%3A14%2B0800&EndTime=2016-07-31T21%3A16%2B0800&CdnType=video&ResultType=1&Granularity=5&DataType=reqhitrate 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetHitRateDetailedData
x-version: 2016-09-01

```

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

### Go SDK - Installation

Source: https://docs.ksyun.com/documents/40767?type=3

Instructions for installing the KS3 SDK for Go.

```APIDOC
## Installation (Go)

### Description
Guides on how to install the KS3 SDK for Go, typically using Go modules.
```

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

### Simple Bucket Creation

Source: https://docs.ksyun.com/documents/42289

This example demonstrates the basic request to create a bucket.

```APIDOC
## PUT /

### Description
Creates a new bucket.

### Method
PUT

### Endpoint
/

### Request Body
- **CreateBucketConfiguration** (object) - Required - Configuration for creating the bucket.
  - **LocationConstraint** (string) - Required - The region where the bucket will be created.

### Request Example
```http
PUT / HTTP/1.1
Host: {BucketName}.{endpoint}
Content-Length: {length}
Date: {date}
Authorization: {SignatureValue}

<CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <LocationConstraint>BEIJING</LocationConstraint>
</CreateBucketConfiguration>
```

### Response
#### Success Response (200)
- **Date** (string) - The date and time the response was generated.
- **Content-Length** (string) - The length of the response body.
- **Connection** (string) - Indicates whether the connection is kept alive.
- **x-kss-request-id** (string) - A unique identifier for the request.
- **x-kss-data-redundancy-type** (string) - The data redundancy type of the bucket.
- **Server** (string) - The server software used.

#### Response Example
```http
HTTP/1.1 200 OK
Date: Fri, 26 Dec 2014 06:30:04 GMT
Content-Length: 0
Connection: keep-alive
x-kss-request-id: f86r2t80l******kf4kmib
x-kss-data-redundancy-type：LRS
Server: KS3
```
```

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

### KSYun OpenAPI GET Request Example

Source: https://docs.ksyun.com/documents/1406

Example of a GET request URL for a KSYun OpenAPI call, demonstrating the placement of common parameters in the query string.

```http
https://iam.api.ksyun.com/?
Action=ListUsers
&Accesskey=AKLTAGFB7-e_Qtest
&Service=iam
&Version=2015-11-01
&Timestamp=2020-08-05T07:16:22Z
&SignatureVersion=1.0
&SignatureMethod=HMAC-SHA256
&Signature=6f00100528da6630b786a9326813916c4b6e77dgagda2d4e4a1b05c7e
&业务参数

```

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

### Local Installation of Python SDK (setup.py - older versions)

Source: https://docs.ksyun.com/documents/40467?type=3

Install the KSYun Python SDK from the local source code using the setup.py script. This method is only applicable for versions prior to 1.16.0.

```bash
python setup.py install
```

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

### HTTP GET Invoke

Source: https://docs.ksyun.com/documents/42045?type=3

Example of a GET request to the http-invoke endpoint.

```APIDOC
## GET /http-invoke

### Description
Invokes an HTTP endpoint with a GET request.

### Method
GET

### Endpoint
/http-invoke

### Request Example
```bash
curl -X POST http://127.0.0.1:8080/http-invoke
```
```

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

### Initialize Client (C++)

Source: https://docs.ksyun.com/documents/43990?type=3

Initializes global network resources, creates a client instance with the host, and prepares the client context with necessary credentials and identifiers. Remember to release network resources after use.

```cpp
#include "ks3.h"

using namespace ks3;

int main() {
    // 初始化网络资源
    sdk::KS3Client::InitGlobalCurl();

    std::string host = "ks3-cn-beijing.ksyuncs.com";
    // 初始化client
    sdk::KS3Client client(host);
    client.Init();

    // 准备client上下文信息

    // 金山云主账号 AccessKey 拥有所有API的访问权限，风险很高。
    // 强烈建议您创建并使用子账号账号进行 API 访问或日常运维，请登录 https://uc.console.ksyun.com/pro/iam/#/user/list 创建子账号。
    std::string ak = "yourAccessKey"; // 填写实际的AccessKey
    std::string sk = "yourSecretKey"; // 填写实际的SecretKey
    // 如有需要，填写桶名
    std::string bucket = "yourBucketName";
    // 如有需要，填写对象名
    std::string object_key = "yourKeyName";

    // 将准备好的信息填入ClientContext
    sdk::ClientContext ctx;
    ctx.bucket = bucket;
    ctx.object_key = object_key;
    ctx.accesskey = ak;
    ctx.secretkey = sk;

    // 其他操作

    // 释放网络资源
    sdk::KS3Client::DestroyGlobalCurl();

    return 0;
}
```

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

### HTTP Request Handler with Flask

Source: https://docs.ksyun.com/documents/42253?type=3

This example shows a Flask application handling various HTTP methods (GET, POST, PUT, DELETE, PATCH) for a '/http-invoke' endpoint. It demonstrates accessing request arguments and body data. Ensure Flask is installed.

```python
import json
import os
# import flask dependency with layer
# sys.path.append('/opt/python')
from cloudevents.http import from_http
from flask import Flask, request, jsonify

app = Flask(__name__)


@app.route("/http-invoke", methods=["GET"])
def get_handler():
    print("receive http get msg")
    print('request.args = ', request.args)
    return "receive get msg", 200


@app.route("/http-invoke", methods=["POST"])
def post_handler():
    print("receive http post msg")
    print('request.args = ', request.args)
    data = request.stream.read()
    if data is None or data == b"":
        # Empty string will cause data to be marshalled into None
        return "body data  is none", 400
    json_data = json.loads(data)
    print('request.body = ', json_data['id'])
    # print('id =', data['id'])
    # return "receive post msg", 200
    return jsonify({'id': "a123"}), 200


@app.route("/http-invoke", methods=["PUT"])
def put_handler():
    print("receive http put msg")
    print('request.args = ', request.args)
    return "receive put msg", 200


@app.route("/http-invoke", methods=["delete"])
def delete_handler():
    print("receive http delete msg")
    print('request.args = ', request.args)
    return "receive delete msg", 200


@app.route("/http-invoke", methods=["PATCH"])
def patch_handler():
    print("receive http patch msg")
    print('request.args = ', request.args)
    return "receive patch msg", 200

def print_env():
    env_dist = os.environ  # environ是在os.py中定义的一个dict environ = {}
    for key in env_dist:
        print(key + ' : ' + env_dist[key])


if __name__ == "__main__":
    # app.run(port=8080)
    app.run(host='0.0.0.0', port=8080, debug=True)
```

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

### Install Helm3 Application Response Example

Source: https://docs.ksyun.com/documents/7983?type=6

This is an example of a successful JSON response when installing a Helm3 application via the KCE API. It includes the RequestId for tracking the operation.

```json
{
"RequestId":""
}
```

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

### HTTP GET Request

Source: https://docs.ksyun.com/documents/42255?type=3

Example of making a GET request to the http-invoke endpoint.

```bash
curl -X GET http://127.0.0.1:80880/http-invoke
```
Tokens:
Raw