All Products
Search

This Product

    Cloud Parallel File Storage:Integration overview

    Document Center

    Cloud Parallel File Storage:Integration overview

    Last Updated:Jun 20, 2026

    This topic describes the integration solutions supported by Cloud Parallel File Storage (CPFS) for Lingjun.

    OpenAPI Explorer

    Alibaba Cloud provides OpenAPI Explorer to help developers quickly and efficiently learn and use the APIs of cloud services. It combines features such as intelligent API search, documentation, online debugging, SDK acquisition, code samples, error diagnosis, and call statistics. You can use OpenAPI Explorer to call the APIs of Alibaba Cloud services and view API requests and responses. OpenAPI Explorer also automatically generates SDK sample code to help you get started with Alibaba Cloud services. For more information, see What is OpenAPI?.

    Versions

    Alibaba Cloud OpenAPI uses version numbers to manage API releases for its services. For example, Cloud Parallel File Storage (CPFS) currently supports the API version 2017-06-26. This identifier is a version number, not a date. It represents the API data structure and does not imply the API has been unchanged since 2017-06-26.

    Note

    Cloud Parallel File Storage (CPFS) and Apsara File Storage NAS share the same SDK. Therefore, use the endpoints and SDK of Apsara File Storage NAS when working with CPFS.

    Version

    Description

    2017-06-26

    Recommended

    Online debugging

    Cloud Parallel File Storage (CPFS) provides features such as API debugging in OpenAPI Explorer. Before you call an API, understand the versions, endpoints, and integration methods that CPFS provides.

    On the OpenAPI Explorer debugging page, the left navigation pane lists file system APIs such as CreateFileSystem, DeleteFileSystem, and DescribeFileSystems. The central pane contains the parameter configuration form for the CreateFileSystem API. This form includes fields such as FileSystemType (valid values: standard, extreme, cpfs), ChargeType (valid values: PayAsYouGo, Subscription), Duration, Capacity, Bandwidth, StorageType (required, marked with a red asterisk), and ZoneId. You can select an endpoint for a specific region, such as China East 1 (Hangzhou). At the bottom of the page is a Send Request button.

    Debugging entry point

    To debug the API, go to Cloud Parallel File Storage (CPFS).

    Endpoints

    To minimize latency, select the endpoint in the same region as your resources. For example, the public endpoint for Cloud Parallel File Storage (CPFS) in the China (Ulanqab) region is nas.cn-wulanchabu.aliyuncs.com, and the VPC endpoint is nas-vpc.cn-wulanchabu.aliyuncs.com.

    • Public endpoints are globally accessible.

    • VPC endpoints are accessible only from within a Virtual Private Cloud (VPC) in the corresponding Alibaba Cloud region. The advantages of a VPC endpoint are:

      • High security: A VPC endpoint can be accessed only from within a VPC, providing greater security and privacy.

      • Faster response: Operating on the internal VPC network, VPC endpoints typically respond faster than public endpoints and are not subject to public network latency or bandwidth limitations.

      • Lower cost: By using the internal network, VPC endpoints can help reduce data transfer costs.

    The following table lists the regions and endpoints supported by Cloud Parallel File Storage (CPFS) for Lingjun.

    Region name

    Region ID

    Public endpoint

    VPC endpoint

    Singapore

    ap-southeast-1

    nas.ap-southeast-1.aliyuncs.com

    nas-vpc.ap-southeast-1.aliyuncs.com

    Supported user identities

    User identity

    Support status

    Alibaba Cloud account

    Supported

    RAM user (Recommended)

    Supported

    RAM role (Recommended)

    Supported

    We recommend using a RAM user or RAM role to make API calls, and granting permissions based on your specific business needs.

    More information

    Integration methods

    Note

    We recommend using an SDK because it is the easiest and best-supported way to call the API.

    Cloud Parallel File Storage (CPFS) for Lingjun supports integration using SDKs and the Alibaba Cloud CLI. You can choose the method that best suits your business needs.

    Alibaba Cloud SDK

    • Alibaba Cloud provides SDKs for multiple programming languages, including Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. You can use these SDKs to call APIs. The SDKs simplify development by handling signing logic, timeouts, retries, and returning structured response objects. For more information about the Alibaba Cloud SDK, see Alibaba Cloud SDK.

    • You can use the Alibaba Cloud SDK to call Cloud Parallel File Storage (CPFS) APIs in OpenAPI Explorer. For information about supported languages and how to install dependencies, see Apsara File Storage NAS SDK.

    Alibaba Cloud CLI

    The Alibaba Cloud CLI allows you to interact with Alibaba Cloud services and manage your cloud resources from the command line by using the aliyun command. For more information about the Alibaba Cloud CLI, see What is Alibaba Cloud CLI.

    Manual API calls (Not recommended)

    To make native HTTP calls, you must implement the signing algorithm and construct custom requests. For more information about the signing mechanism, see API reference and V3 request body and signature mechanism.

    Usage notes

    • If an API call returns an error, use the returned error code to verify that your request parameters and values are correct. For more information, see Error Code Center.

    • You can also record the RequestID or SDK error message returned from the call and use the Alibaba Cloud OpenAPI Diagnosis Platform for self-service diagnostics.