Python SDK sample code

View the OpenAPI documentation

Read the API overview to learn that the DescribeFileSystems operation is used to query file system information. Refer to the documentation to understand the required data and permissions for calling this operation.

Create a RAM user and grant permissions

1. Create a RAM user.

   1. Go to User List and click Create user.

   2. Set Logon name to nas-openapi-operator, and select Access Mode as Use a permanent AccessKey for access.

   3. Click OK to create a RAM user and save the AccessKey ID and AccessKey Secret.

2. Grant permissions.

   1. Go to User List and click Actions in the Add permissions column of the target RAM user.

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

      Important

      The AliyunNASFullAccess policy grants full operational permissions. You can also select the AliyunNASReadOnlyAccess policy, which grants read-only access and viewing permissions, or create a custom policy as needed. For more information, see Control NAS access with RAM policies.

   3. Click OK to complete the authorization.

Call the OpenAPI

This topic uses the Alibaba Cloud software development kit (SDK) for Python to call the OpenAPI. The usage of SDKs for other languages is similar. For more information, see the Apsara File Storage NAS/CPFS SDK.

Prepare Python environment

Download and install Python 3. If you already have Python installed, you can run the following command to check its version: python --version.

Configure environment variables

To avoid security risks from hard coding your AccessKey into your business code, you can configure environment variables to manage your AccessKey. This topic shows how to set the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables. You can replace the variable names as needed, such as with NAS_ACCESS_KEY_ID and NAS_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

On your terminal, run the following commands one by one to install the dependencies.

pip install alibabacloud_nas20170626==2.0.3
pip3 install alibabacloud_tea_console

Download the sample code

1. Go to DescribeFileSystems in OpenAPI Portal.

2. On the Parameter configuration tab on the left, fill in the required parameter information. In this example, Endpoint is set to China (Hangzhou).

3. On the SDK sample tab on the right, select the Python language, click the Download the complete project button, and download the sample code package.

4. Decompress the package on your computer and go to the alibabacloud_sample folder.

Run the code

Run the following command:

python sample.py

The following example shows a sample response:

{
    "headers":{
        "date":"Wed, 26 Jul 2023 09:03:41 GMT",
        "content-type":"application/json;charset=utf-8",
        "content-length":"1033",
        "connection":"keep-alive",
        "keep-alive":"timeout=25",
        "vary":"Accept-Encoding",
        "access-control-allow-origin":"*",
        "access-control-expose-headers":"*",
        "x-acs-request-id":"31BF0F2B-9C5F-5FD3-88FA-60621657****",
        "x-acs-trace-id":"5842784c3ae9fe9bdcb255bfaa61****",
        "etag":"14PmeGvuG5exKT8M004b****"
    },
    "body":{
        "PageNumber":1,
        "RequestId":"31BF0F2B-9C5F-5FD3-88FA-60621657****",
        "PageSize":10,
        "TotalCount":1,
        "FileSystems":{
            "FileSystem":[
                {
                    "Status":"Running",
                    "Capacity":10485760,
                    "MeteredIASize":0,
                    "CreateTime":"2023-07-24T11:36:17CST",
                    "ChargeType":"PayAsYouGo",
                    "StorageType":"Capacity",
                    "RegionId":"cn-hangzhou",
                    "FileSystemType":"standard",
                    "FileSystemId":"197df64****",
                    "MeteredSize":10625024,
                    "EncryptType":0,
                    "Description":"test",
                    "ExpiredTime":"",
                    "ZoneId":"cn-hangzhou-g",
                    "ProtocolType":"NFS",
                    "KMSKeyId":"",
                    "MountTargets":{
                        "MountTarget":[
                            {
                                "VpcId":"vpc-2vc1h319fodms9p76****",
                                "Status":"Active",
                                "MountTargetDomain":"197df64****-j****.cn-hangzhou.nas.aliyuncs.com",
                                "AccessGroupName":"DEFAULT_VPC_GROUP_NAME",
                                "VswId":"vsw-2vcapqvrrxjn15n0m****",
                                "NetworkType":"vpc",
                                "ClientMasterNodes":{
                                    "ClientMasterNode":[

                                    ]
                                },
                                "Tags":{
                                    "Tag":[

                                    ]
                                }
                            }
                        ]
                    },
                    "Packages":{
                        "Package":[

                        ]
                    },
                    "SupportedFeatures":{
                        "SupportedFeature":[
                            "Lifecycle",
                            "Quota",
                            "Acl"
                        ]
                    },
                    "Ldap":{

                    }
                }
            ]
        }
    }
}