Alipay Cloud

https://opendocs.alipay.com/cloud/
Admin
Alipay Cloud is a cloud services platform providing documentation and tools for developers to...
Tokens:461,277
Snippets:4,896
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Document Data - Mini Program Client Example

Source: https://opendocs.alipay.com/cloud/089cba

Example of how to use the 'get' method from the mini program client-side to retrieve document data.

```javascript
my.request({ // 替换为实际的云函数调用方式
  url: 'YOUR_CLOUD_FUNCTION_URL',
  data: {
    method: 'get',
    // 如果需要指定获取的文档ID，可以在这里传递
    // docId: 'YOUR_DOCUMENT_ID'
  },
  success: function(res) {
    console.log('Document data:', res.data);
  },
  fail: function(err) {
    console.error('Error getting document:', err);
  }
});
```

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

### Cloud Function Initialization (NodeJS SDK)

Source: https://opendocs.alipay.com/cloud/089ca7

This section covers the initialization process for Cloud Functions, databases, and cloud storage. It explains how to specify a cloud environment ID using the `init` method and configure request timeouts. It also details how to install the necessary SDK dependency and provides examples for using the default `Cloud` instance and creating new `Cloud` instances.

```APIDOC
## Cloud Function Initialization

### Description
Initializes Cloud Functions, databases, and cloud storage. Allows specifying the cloud environment ID and configuring request timeouts.

### Method
`init(config?: { env?: string, timeout?: number | [number, number] })`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Using the default instance
Cloud.init({
  env: 'YOUR_ENV_ID',
  timeout: 5000 // 5 seconds
});

// Creating a new instance
const myCloud = new Cloud();
myCloud.init({
  env: 'ANOTHER_ENV_ID',
  timeout: [1000, 3000] // 1 second connect, 3 seconds response
});
```

### Response
#### Success Response (200)
N/A (Initialization is a configuration step, not an API call with a direct response)

#### Response Example
None
```

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

### Get Collection Example

Source: https://opendocs.alipay.com/cloud/089cat

Example of how to get a collection object and perform a 'get' operation using the NodeJS SDK.

```typescript
const cloud = require("@alipay/faas-server-sdk");

exports.main = async (event, context) => {
const db = cloud.database()
return await db.collection('example').get()
};
```

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

### Example settings-deploy.xml

Source: https://opendocs.alipay.com/cloud/08jly3

Create this file in the root of your code repository. The variables ${username}, ${userpassword}, and ${tenant} are automatically replaced during task execution.

```xml
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <servers>
    <server>
      <id>releases</id>
      <username>${username}</username>
      <password>${userpassword}</password>
    </server>
    <server>
      <id>snapshots</id>
      <username>${username}</username>
      <password>${userpassword}</password>
    </server>
  </servers>
  <mirrors>
    <mirror>
      <id>nexus</id>
      <mirrorOf>central</mirrorOf>
      <url>http://maven.alipay.com/nexus/content/groups/public/</url>
    </mirror>
  </mirrors>
  <profiles>
    <profile>
      <id>alipay</id>
      <repositories>
        <repository>
          <id>releases</id>
          <url>http://maven.alipay.com/nexus/content/repositories/releases/</url>
          <releases><enabled>true</enabled></releases>
          <snapshots><enabled>false</enabled></snapshots>
        </repository>
        <repository>
          <id>snapshots</id>
          <url>http://maven.alipay.com/nexus/content/repositories/snapshots/</url>
          <releases><enabled>false</enabled></releases>
          <snapshots><enabled>true</enabled></snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>releases</id>
          <url>http://maven.alipay.com/nexus/content/repositories/releases/</url>
          <releases><enabled>true</enabled></releases>
          <snapshots><enabled>false</enabled></snapshots>
        </pluginRepository>
        <pluginRepository>
          <id>snapshots</id>
          <url>http://maven.alipay.com/nexus/content/repositories/snapshots/</url>
          <releases><enabled>false</enabled></releases>
          <snapshots><enabled>true</enabled></snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>alipay</activeProfile>
  </activeProfiles>
</settings>
```

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

### .NET SDK - Public Key Authentication Example

Source: https://opendocs.alipay.com/cloud/09nrsj

Example demonstrating how to initialize the Alipay client using the public key authentication method in .NET.

```csharp
IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "APPID", "PRIVATE_KEY", "JSON", "UTF-8", "RSA2");
```

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

### Delete File API Request Example (Java)

Source: https://opendocs.alipay.com/cloud/089gup

Example of how to call the delete file API using Java. This snippet demonstrates the necessary setup and parameters for the request.

```java
String url = "https://openapi.alipay.com/v3/alipay/cloud/cloudrun/objectstorage/filelist/delete";
String env = "env-123456789000";
String fileId = "cloud://a/b/c.jpg";

// Construct the request body
JSONObject requestBody = new JSONObject();
requestBody.put("file_id_list", new JSONArray().put(fileId));

// Construct the full URL with query parameters
String fullUrl = url + "?env=" + env;

// Set up headers
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
headers.set("authorization", "YOUR_AUTHORIZATION_TOKEN");

// Create the request entity
HttpEntity<String> requestEntity = new HttpEntity<>(requestBody.toString(), headers);

// Make the POST request (using RestTemplate or similar HTTP client)
// RestTemplate restTemplate = new RestTemplate();
// ResponseEntity<String> response = restTemplate.exchange(fullUrl, HttpMethod.POST, requestEntity, String.class);

// Process the response...
```

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

### Example settings-deploy.xml

Source: https://opendocs.alipay.com/cloud/08jly4

Create a settings-deploy.xml file in the root of your code repository. This file is used for deployment configurations. Variables like ${username}, ${userpassword}, and ${tenant} are automatically replaced during task execution.

```xml
<settings>
  <servers>
    <server>
      <id>releases</id>
      <username>${username}</username>
      <password>${userpassword}</password>
    </server>
  </servers>
  <mirrors>
    <mirror>
      <id>nexus</id>
      <mirrorOf>*</mirrorOf>
      <url>http://11.11.11.11:8081/repository/maven-public/</url>
    </mirror>
  </mirrors>
  <profiles>
    <profile>
      <id>nexus</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>http://central</url>
          <releases>
            <enabled>true</enabled>
            <updatePolicy>update</updatePolicy>
          </releases>
          <snapshots>
            <enabled>true</enabled>
            <updatePolicy>always</updatePolicy>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>central</id>
          <url>http://central</url>
          <releases>
            <enabled>true</enabled>
            <updatePolicy>update</updatePolicy>
          </releases>
          <snapshots>
            <enabled>true</enabled>
            <updatePolicy>always</updatePolicy>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
  </profiles>
  <activeProfiles>
    <activeProfile>nexus</activeProfile>
  </activeProfiles>
</settings>
```

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

### Java SDK - Public Key Authentication Example

Source: https://opendocs.alipay.com/cloud/09nrsj

Example demonstrating how to initialize the Alipay client using the public key authentication method in Java.

```java
DefaultAlipayClient client = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", "APPID", "PRIVATE_KEY", "JSON", "UTF-8", "RSA2");
```

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

### AOS Suggest Query API cURL Example

Source: https://opendocs.alipay.com/cloud/089fvw

This cURL example demonstrates how to call the alipay.open.mini.cloud.aossuggest.query API to get input suggestions. Ensure you replace placeholders like ${sign}, ${appid}, and ${now} with actual values.

```cURL
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.open.mini.cloud.aossuggest.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'biz_content= {
	"client_env":"ios",
	"size":5,
	"device_id":"01010Jq02O5XceJUHST0Q2nWlRFY",
	"user_id":"2088310000020000",
	"open_id":"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5",
	"project_id":"10000410",
	"query":"ip",
	"latitude":"30.355",
	"user_id_type":"ALIPAY",
	"city_code":"330100",
	"longitude":"120.24"
}' 
```

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

### Get File Upload URL - Java Example

Source: https://opendocs.alipay.com/cloud/089gun

Example demonstrating how to obtain a file upload URL using the V3 version of the Alipay Cloud SDK for Java. This is the first step in the non-direct upload process.

```Java
AlipayClient client = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", "APPID", "APP_PRIVATE_KEY", "json", "CHARSET", "ALIPAY_PUBLIC_KEY", "RSA2");
AlipayCloudCloudrunObjectstorageUploadurlGetRequest req = new AlipayCloudCloudrunObjectstorageUploadurlGetRequest();
req.setBizContent("{
```

```Java
"env":"miniapp-test-env-000000000001",
```

```Java
"path":"/a/b/c.jpg"
```

```Java
}");
AlipayCloudCloudrunObjectstorageUploadurlGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());
```

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

### PHP SDK - Public Key Authentication Example

Source: https://opendocs.alipay.com/cloud/09nrsj

Example demonstrating how to initialize the Alipay client using the public key authentication method in PHP.

```php
$alipay_config = [
    'gatewayUrl'    => 'https://openapi.alipay.com/gateway.do',
    'appId'         => 'APPID',
    'merchantPrivateKey' => 'PRIVATE_KEY',
    'format'        => 'JSON',
    'charset'       => 'UTF-8',
    'signType'      => 'RSA2',
];
$client = new 

AlipayClient($alipay_config);
```

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

### Java Code Explanation Example

Source: https://opendocs.alipay.com/cloud/09zd0j

Illustrates how to get an explanation for a selected code snippet by right-clicking and choosing 'CodeFuse: Explain Code'.

```java
public class Calculator {
    public int add(int a, int b) {
        return a + b;
    }

    public int subtract(int a, int b) {
        return a - b;
    }
}
```

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

### .NET SDK - Certificate Authentication Example

Source: https://opendocs.alipay.com/cloud/09nrsj

Example demonstrating how to initialize the Alipay client using the public key certificate authentication method in .NET. Ensure the certificate paths are correctly configured.

```csharp
IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "APPID", "PRIVATE_KEY", "JSON", "UTF-8", "RSA2", "app_cert_path", "alipay_cert_path", "alipay_root_cert_path");
```

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

### Java SDK - Certificate Authentication Example

Source: https://opendocs.alipay.com/cloud/09nrsj

Example demonstrating how to initialize the Alipay client using the public key certificate authentication method in Java. Ensure the certificate paths are correctly configured.

```java
DefaultAlipayClient client = new DefaultAlipayClient( "https://openapi.alipay.com/gateway.do", "APPID", "PRIVATE_KEY", "JSON", "UTF-8", "RSA2", "app_cert_path", "alipay_cert_path", "alipay_root_cert_path");
```

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

### Example Usage of collection.count

Source: https://opendocs.alipay.com/cloud/089gu1

Demonstrates how to use the collection.count method to get the total number of documents and the count of documents matching a filter.

```Java
long totalCount = mongoCollection.count();

Bson filter = Filters.gt("create_time", "123456");
long count = mongoCollection.count(filter);
```

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

### PHP SDK - Certificate Authentication Example

Source: https://opendocs.alipay.com/cloud/09nrsj

Example demonstrating how to initialize the Alipay client using the public key certificate authentication method in PHP. Ensure the certificate paths are correctly configured.

```php
$alipay_config = [
    'gatewayUrl'    => 'https://openapi.alipay.com/gateway.do',
    'appId'         => 'APPID',
    'merchantPrivateKey' => 'PRIVATE_KEY',
    'alipayPublicKey'    => 'ALIPAY_PUBLIC_KEY',
    'certPath'      => 'app_cert_path',
    'keyPath'       => 'app_private_key_path',
    'alipayCertPath'    => 'alipay_cert_path',
    'rootCertPath'  => 'alipay_root_cert_path',
    'format'        => 'JSON',
    'charset'       => 'UTF-8',
    'signType'      => 'RSA2',
];
$client = new 

AlipayClient($alipay_config);
```

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

### Get Total Document Count

Source: https://opendocs.alipay.com/cloud/089gu1

Retrieves the total number of documents in a collection. No specific setup is required beyond having a valid collection object.

```Java
long count();
```

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

### Optimized Dockerfile with Base Software Installation Before Code Copy

Source: https://opendocs.alipay.com/cloud/089gwo

This example demonstrates the recommended order for Dockerfile instructions. Installing base software (RUN commands) before copying application code (COPY command) allows for better cache utilization if the base software hasn't changed.

```Dockerfile
FROM registry.cloudrun.cloudbaseapp.cn/cloudrun-xxxx/php-base:5.6-fpm-stretch

# Install base software (low frequency change)
RUN apt-get update && apt-get install -y \
    git \
    vim \
    wget \
    curl \
    zip \
    unzip \
    supervisor \
    memcached \
    redis-tools \
    cron

# Install PHP extensions
RUN docker-php-ext-install -j$(nproc) \
    opcache \
    pdo \
    pdo_mysql \
    mysqli \
    mbstring \
    exif \
    zip \
    pcntl \
    bcmath

# Install Composer
RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

# Copy application code (high frequency change)
COPY . /var/www/html

# Set working directory
WORKDIR /var/www/html

# Clean up apt cache
RUN apt-get clean && rm -rf /var/lib/apt/lists/*
```

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

### Create Migration Project (Cloud Hosting Console)

Source: https://opendocs.alipay.com/cloud/091nef

This example demonstrates initiating a data migration project within the Cloud Hosting console. It involves navigating to the database section and clicking 'Create Migration Project'.

```shell
登录云托管控制台 ，在左侧导航栏选择数据存储 > 数据库，单击数据库实例，进入到实例信息页面，单击数据迁移。
在数据迁移页面，单击右上角的创建迁移项目。
```

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

### URL Authentication Example

Source: https://opendocs.alipay.com/cloud/089c9o

Example demonstrating how to construct a signed URL for object storage, including domain name, file path, expiration timestamp, and a calculated signature.

```N/A
DomainName: env-test00000001.normal.cloudstatic.cn
SignSecretKey: testkey
ExpireTimestamp: 1699602561
FilePath: /测试.jpg
```

```N/A
SignSecretKey + FilePath + ExpireTimestamp = testkey/测试.jpg1699602561
```

```N/A
Sign = md5sum("testkey/测试.jpg1699602561")
```

```N/A
https://env-test00000001.normal.cloudstatic.cn/测试.jpg?expire_at=1699602561&sign=a1b2c3d4e5f67890a1b2c3d4e5f67890
```

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

### Get File Upload URL Java Example

Source: https://opendocs.alipay.com/cloud/0905eg

This Java code snippet demonstrates how to obtain a file upload URL using the `alipay.cloud.cloudrun.staticsite.uploadurl.create` OpenAPI. Ensure you have the correct environment ID and file path.

```java
/**
 * 获取文件上传链接示例
 */
public void getUploadUrl() {
    // 1. 初始化 OpenAPI 客户端
    // Environment.init("YOUR_APP_ID", "YOUR_PRIVATE_KEY", Environment.SANDBOX);
    // 2. 构造请求参数
    AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", "YOUR_APP_ID", "YOUR_PRIVATE_KEY", "json", "UTF-8");
    AlipayCloudCloudrunStaticsiteUploadurlCreateRequest request = new AlipayCloudCloudrunStaticsiteUploadurlCreateRequest();
    request.setEnv("env-xxxxxxx"); // 必填，环境 ID
    request.setPath("/a/b/c"); // 必填，文件路径
    request.setContentType("application/json"); // 可选，文件类型

    // 3. 发送请求
    try {
        AlipayCloudCloudrunStaticsiteUploadurlCreateResponse response = alipayClient.execute(request);
        // 4. 处理响应
        if (response.isSuccess()) {
            System.out.println("获取上传链接成功：");
            System.out.println("File ID: " + response.getFileId());
            System.out.println("Upload URL: " + response.getUploadUrl());
        } else {
            System.err.println("获取上传链接失败：" + response.getMsg());
        }
    } catch (AlipayApiException e) {
        e.printStackTrace();
    }
}
```

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

### Get Hardening Result Download Link (HTTP)

Source: https://opendocs.alipay.com/cloud/08ube9

This HTTP example shows a direct API call to fetch the hardening result download link. It includes common request parameters and the biz_content with the task_id.

```HTTP
POST /gateway.do HTTP/1.1
Host: openapi.alipay.com
Content-Type: application/x-www-form-urlencoded;charset=utf-8

app_id=2014072300007148&method=alipay.security.prod.ashield.hardeningresult.get&format=JSON&charset=utf-8&sign_type=RSA2&sign=YOUR_SIGN&timestamp=2014-07-24+03:07:50&version=1.0&biz_content={"task_id":"DB568579D0494B13D130683C665F73E2"}
```

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

### Login using Command Line Flags

Source: https://opendocs.alipay.com/cloud/089gvw

How to log in to the cloud hosting service using command-line flags for APPID and private key.

```bash
cpt login --appid "your_appid" --private_key "your_private_key"
```

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

### Start Migration

Source: https://opendocs.alipay.com/cloud/089guv

Initiate the data migration process using the ossmigrate tool.

```bash
./ossmigrate -c ./conf/config.ini
```

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

### Get Upload File Token (cURL)

Source: https://opendocs.alipay.com/cloud/08uf2f

This cURL example demonstrates how to request an upload file token using the alipay.security.prod.ashield.filetoken.get API. Ensure you replace placeholders like ${sign}, ${appid}, and ${app_auth_token} with your actual values.

```shell
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.security.prod.ashield.filetoken.get&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'app_auth_token=${app_auth_token}'
```

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

### Cleaning Up Temporary Files in RUN Commands

Source: https://opendocs.alipay.com/cloud/089gwo

This example demonstrates cleaning up temporary files generated during package installation within the same RUN command. This prevents these temporary files from being included in the final image layer, reducing its size.

```Dockerfile
FROM fedora:latest

# Install packages and clean up in the same RUN command
RUN dnf install -y httpd && \
    dnf clean all && \
    rm -rf /var/cache/dnf/*
```

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

### Create Scene Project (Java)

Source: https://opendocs.alipay.com/cloud/089fvr

Java code example for creating a personalized recommendation scene project. Ensure you have the necessary Alipay client and request objects initialized.

```Java
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
TechriskInnovateMpcpromoSceneCreateRequest request = new TechriskInnovateMpcpromoSceneCreateRequest();
request.setBizContent("{\"scene_project_name\":\"recommendDaliy\",\
  \"scene_description\":\"256\",\
  \"position_code\":\"1205\",\
  \"recommend_type\":\"GOODS_INFO\",\
  \"data_list\":[\
    \"113210\",\
    \"113211\"
  ]\
}");
TechriskInnovateMpcpromoSceneCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
```

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

### Java Example for Behavior Sync

Source: https://opendocs.alipay.com/cloud/089fvt

This Java code snippet demonstrates how to initialize the Alipay client and set up a request to synchronize user behavior data.

```Java
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
TechriskInnovateMpcpromoBehaviorSyncRequest request = new TechriskInnovateMpcpromoBehaviorSyncRequest();
request.setBizContent("{\"user_id\":\"2088310000020000\",
```

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

### Get Upload File Token Response Example

Source: https://opendocs.alipay.com/cloud/08uf2f

This JSON object represents a successful response from the alipay.security.prod.ashield.filetoken.get API. It includes details like access ID, directory, expiration time, host, policy, and signature required for uploading files.

```json
{
    "alipay_security_prod_ashield_filetoken_get_response": {
        "code": "10000",
        "msg": "Success",
        "request_id": "3e399ed09a7a41e28bd8579132d71333",
        "res_data": {
            "access_id": "LTAI5tBVrCqciJ6VurkTEJjK",
            "dir": "hardening/open/1/20230517151031828624/",
            "expire": "1684307461",
            "host": "oss的host地址",
            "policy": "eyJleHBpcmF0aW9uIjoiMjAyMy0wNS0xN1QwNzoxMTowMS44MjhaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsImhhcmRlbmluZy9vcGVuLzEvMjAyMzA1MTcxNTEwMzE4Mjg2MjQvIl1dfQ==",
            "signature": "0hI4WicSgBUjMIffjrUgG0CJHw0="
        }
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
```

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

### Install CodeFuse Plugin from Disk

Source: https://opendocs.alipay.com/cloud/09yzgn

Install the CodeFuse plugin in IntelliJ IDEA by selecting the downloaded .zip installation package.

```text
File > Settings (Ctrl + Alt + S)
Plugins > Install Plugin from Disk…
```

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

### Example HTTP API Service Registration

Source: https://opendocs.alipay.com/cloud/0975gf

An example command for registering a service locally. Replace 'http://localhost' with your public test domain for cloud hosting.

```bash
curl -X PUT -d '{"Name": "my-app", "ServiceAddress": "127.0.0.1", "ServicePort": 8080, "IPAddress": "http://localhost"}' http://localhost:8500/v1/agent/service/register
```

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

### Configuring Database Connection

Source: https://opendocs.alipay.com/cloud/089gr6

Example demonstrating how to configure database connection details such as host, port, and database name within the service template.

```yaml
default:
  db_host: "your-db-host"
  db_port: 5432
  db_name: "your-db-name"
```

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

### cURL Request for Alipay Open Mini Cloud Aoshint Query

Source: https://opendocs.alipay.com/cloud/089fvy

This cURL example demonstrates how to call the alipay.open.mini.cloud.aoshint.query API to get search suggestions. Ensure you replace placeholders like ${sign}, ${appid}, ${app_auth_token}, and ${now} with your actual values. The biz_content includes various parameters for customizing the search, such as sort type, client environment, user ID, and project ID.

```cURL
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.open.mini.cloud.aoshint.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2&timestamp=${now}' \
 -F 'app_auth_token=${app_auth_token}' \
 -F 'biz_content=ột
	"sort_type":"pv",
	"client_env":"ios",
	"size":"5",
	"device_id":"01010Jq02O5XceJUHST0Q2nWlRFY",
	"user_id":"2088310000020000",
	"open_id":"074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5",
	"project_id":"10000410",
	"latitude":"30.355",
	"user_id_type":"ALIPAY",
	"city_code":"330100",
	"longitude":"120.24"
'
```

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

### Example Service Registration Command

Source: https://opendocs.alipay.com/cloud/0a373d

An example command for registering a service using the HTTP API. Replace placeholders with your actual service details. This command is for local testing and can be adapted for cloud environments.

```bash
curl --request PUT --data @/v1/agent/service/register.json http://localhost:8500/v1/agent/service/register
```

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

### Response Example

Source: https://opendocs.alipay.com/cloud/089fvo

Examples of successful and abnormal responses.

```APIDOC
## Response Example

**Normal Example**
**Abnormal Example**
```json
{
    "techrisk_innovate_mpcpromo_data_sync_response": {
        "code": "10000",
        "msg": "Success",
        "check_info_list": [
            {
                "id": "201058",
                "title": "Ant Manor Plush Toy",
                "check_info": "Product ID is empty"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
```

Note: This example is for reference only.
```

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

### Create and Start Migration Project

Source: https://opendocs.alipay.com/cloud/091nef

Once the pre-check is complete, you can create and start the migration project. This action initiates the data migration process based on the configured parameters.

```shell
预检查完成后，单击右下角创建项目并启动。
```

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

### Login using Configuration File Flag

Source: https://opendocs.alipay.com/cloud/089gvw

How to log in to the cloud hosting service by specifying a configuration file using the --config flag.

```bash
cpt login --config "path/to/your/config.json"
```

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

### Extract Installation Package

Source: https://opendocs.alipay.com/cloud/0a2lb9

Use this command to extract the ossmigrate installation package after downloading it. Ensure you replace 'installation package name' with the actual filename.

```Shell
tar xf 安装包名字
```

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

### Installing Extensions in Codespaces

Source: https://opendocs.alipay.com/cloud/08jm0j

Install extensions from the extension market within the Java 11 workspace. Installed extensions are automatically synchronized for new workspaces.

```bash
Search for the plugin name in the search box at the top of the extension market page, e.g., Git History.
Click Install on the right side of the search result, and wait for the installation to complete.
```

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

### Quick Commands for Code Explanation and Testing

Source: https://opendocs.alipay.com/cloud/09yzgn

Use quick commands '/Explain' and '/Test' in the editor to explain selected code or generate test cases.

```text
/Explain
/Test
```

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

### Install Function Template from Detail Page

Source: https://opendocs.alipay.com/cloud/09enfz

Install a function template after reviewing its details on the function template detail page. This approach provides more information about the function before installation.

```javascript
1. On the Function Template page, click any template.
2. On the Function Template detail page, view the function and install the template.
○ Click the corresponding function name in the function list to view detailed information about the function.
○ On the template detail page, click Install in the upper right corner to select the mini program and environment, then click Confirm to complete the installation.
3. You can also view or post comments below the function template detail page.
```

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

### Install Function Template from Template Detail Page

Source: https://opendocs.alipay.com/cloud/09cq1m

Install a function template after reviewing its detailed usage instructions on the template detail page. This allows for a more informed installation process.

```javascript
1. On the Function Template page, click any template.
2. On the Function Template detail page, view the function and install the template.
○ Click the corresponding function name in the function list to view the detailed information of the function.
○ On the template detail page, click Install in the upper right corner to select the mini program and environment, and then click Confirm to install successfully.
```

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

### CodeLens Debugging for Application Entry Points

Source: https://opendocs.alipay.com/cloud/08jm0j

Start applications by clicking 'Run | Debug' on the CodeLens prompt above the main entry function of the startup class. This is applicable for SOFA and SOFABoot projects.

```bash
Click on the search icon in the left menu bar of the workspace to open the search panel.
Enter the startup class main entry function in the input field at the top of the search panel.
Click on the search result.
Click Run | Debug in CodeLens to start the application.
```

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

### Installing Plugins in IntelliJ IDEA

Source: https://opendocs.alipay.com/cloud/09awrr

Install plugins like CodeGlance within the Codespaces Java 11 (IntelliJ IDEA) environment. Installed plugins are automatically synchronized to new workspaces.

```text
1. Navigate to File > Settings > Plugins.
2. Search for the plugin name (e.g., CodeGlance).
3. Click 'Install' next to the search result.
4. Click 'OK' after installation.
```

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

### Online Full Migration Example

Source: https://opendocs.alipay.com/cloud/0a2lba

This outlines the process for online full migration. Note that Redis cluster mode is not currently supported. You will need to provide source Redis connection details.

```bash
# 1. Select 'Online Full Migration' in the migration task.
# 2. Enter source Redis access address and password.
# 3. The rest of the process is the same as offline full migration.
```

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

### Installing a Plugin in IntelliJ IDEA

Source: https://opendocs.alipay.com/cloud/09b6lz

This snippet shows how to search for and install a plugin, such as CodeGlance, within the IntelliJ IDEA environment in Codespaces. Installed plugins are automatically synchronized for new workspaces.

```bash
Install
```

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

### Start Data Migration (Default Config)

Source: https://opendocs.alipay.com/cloud/0a2lb9

Initiate the data migration process. If no configuration file is specified, the tool will use 'conf/config.ini' by default.

```Shell
./ossmigrate
```

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

### API Response Example

Source: https://opendocs.alipay.com/cloud/089fvp

An example demonstrating a successful API response structure.

```APIDOC
## API Response Example

### Description
This example shows a typical successful response from an API call, including common and business-specific parameters.

### Response Example
```json
{
    "techrisk_innovate_mpcpromo_behavior_sync_response": {
        "code": "10000",
        "msg": "Success",
        "trace_id": "0b9204f0162970949974145151770"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
```

**Note:** This example is for reference only.
```

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

### Verify CPT CLI Installation

Source: https://opendocs.alipay.com/cloud/089cbq

Execute the 'cpt' command to confirm that the installation was successful and the CLI is recognized by the system. This will display the CPT CLI's usage information and available commands.

```Go
% cpt
支付宝小程序云CLI工具
  
Usage:
cpt [command]
  
Available Commands:
cloudrun 云托管命令
login 登录小程序云
logout 登出小程序云
migrate 云迁移命令
version 打印CPT版本号
  
Flags:
--config string config file (default is $HOME/.cpt.yaml)
-h, --help help for cpt
  
Use "cpt [command] --help" for more information about a command.
```
Tokens:
Raw