Example of calling an API operation (SDK)

View the API documentation

Before you call an API operation, we recommend that you read the API documentation to learn about the parameters and permissions that are required to call the API operation. For more information, see API overview.

Create a Resource Access Management (RAM) user and grant permissions to the RAM user

1. Create a RAM user.

   1. Log on to the RAM console. Go to the Users page and click Create User.

   2. Set Logon Name to cpfs-openapi-operator and set Access Mode to Using permanent AccessKey to access.

   3. Click OK. On the page that appears, save the AccessKey ID and AccessKey secret of the RAM user that you created.

2. Grant authorization.

   1. On the Users page, find the RAM user and click Add Permissions in the Actions column.

   2. In the text box, search for AliyunNAS and select the AliyunNASReadOnlyAccess policy.

      Important

      The AliyunNASFullAccess policy has the permissions to perform operations. You can also select the AliyunNASReadOnlyAccess policy (which has the access and viewing permissions) or create custom policies. For more information, see Control NAS access with RAM policies.

   3. Click Grant permissions to complete the authorization.

Call an API operation

This topic describes how to use the Alibaba Cloud SDK for Python to call API operations. The SDKs for other languages can also be used to call API operations in a similar way. For more information, see File Storage (NAS/CPFS) SDK.

Install Python

Download and install Python 3. If you have Python installed, run the python --version command to check the version.

Configure environment variables

To avoid the security risks of hard-coding your AccessKey pair in your code, we recommend that you configure environment variables to manage the AccessKey pair. This topic uses the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables as an example. You can replace the variable names as needed, such as with CPFS_ACCESS_KEY_ID and CPFS_ACCESS_KEY_SECRET.

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::User)

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::Machine)

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "yourAccessKeyID"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "yourAccessKeySecret"

Install dependencies

Run the following commands on your terminal to install environment dependencies:

pip install alibabacloud_nas20170626==2.0.3
pip3 install alibabacloud_tea_console

Download the sample code

The following procedure uses the DescribeFileSystems operation as an example. You can select the required API operations in OpenAPI Portal.

1. In OpenAPI Explorer, go to the DescribeFileSystems page.

2. In the navigation pane on the left, click the Parameters tab and configure the required parameters. In this example, set Region to China (Hangzhou).

3. On the SDK Sample Code tab on the right, select Python and then click Download Project to download the sample code package.

4. Decompress the package to an on-premises directory and go to the alibabacloud_sample directory.

Run the code

Run the following command:

python sample.py

Sample command output:

{
  "FileSystems": {
    "FileSystem": [
      {
        "Options": {},
        "GuiInfo": {},
        "MountTargetCountLimit": 1,
        "Description": "",
        "NodeNum": 0,
        "ResourceGroupId": "rg-acfm26gwrru****",
        "MeteredSize": 0,
        "VswIds": {
          "VswId": [
            "vsw-8vbmuylc3di7980tj****"
          ]
        },
        "Capacity": 3600,
        "Version": "2.3.4",
        "Packages": {
          "Package": []
        },
        "Bandwidth": 360,
        "ExpiredTime": "",
        "FileSystemId": "cpfs-09b1ccb80257****",
        "Tags": {
          "Tag": []
        },
        "Status": "Running",
        "AccessPointCount": 0,
        "StorageType": "advance_100",
        "Ldap": {},
        "ZoneId": "cn-zhangjiakou-c",
        "CreateTime": "2024-9-6 15:39:27",
        "SupportedFeatures": {
          "SupportedFeature": []
        },
        "MountTargets": {
          "MountTarget": []
        },
        "AutoSnapshotPolicyId": "",
        "EncryptType": 0,
        "VpcId": "vpc-8vbqmlw7s97hu0q1d****",
        "ChargeType": "PayAsYouGo",
        "ProtocolType": "cpfs",
        "FileSystemType": "cpfs",
        "RegionId": "cn-zhangjiakou"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "6E561766-2667-522A-B38A-9AE846F05B1C",
  "PageSize": 10,
  "PageNumber": 1
}