View the database file list

Last Updated: Dec 06, 2017


Note: This API is only applicable to SQL Server instances.

View the file list on the file server. You can use the “Getting a File Upload Address” interface to obtain the account required to upload files to the file server. RDS updates the data file status after data files are uploaded. The user can use the “Viewing the Database File List” interface to check whether data files are available.

If files are available, the user can import data and obtain information about the import process.

Request parameters

Name Type Required? Description
Action String Yes Required parameter. Value: DescribeFilesForSQLServer.
DBInstanceId String Yes Instance ID.
StartTime String Yes Query start time, for example, 2011-06-11T15:00Z.
EndTime String Yes Query end time, which must be later than the query start time, for example, 2011-06-11T16:00Z.
PageSize Integer No Number of records on every page. Values: 30, 50, and 100. Default value: 30.
PageNumber Integer No Page number, which must be greater than 0, but must not exceed the maximum Integer value. Default value: 1.

Return parameters

Name Type Description
DBInstanceId String Instance ID.
TotalRecordCount Integer Total number of records.
PageNumber Integer Page number.
PageRecordCount Integer Number of SQL statements displayed on the current page.
Items List<SQLServerUploadFile> None.

SQLServerUploadFile parameters

Name Type Description
DBName String Name of a database.
FileName String Data file name, with the extension.
FileSize Long Data file size, in the unit of bytes.
InternetFtpServer String File server.
InternetPort Integer Port number on the file server.
IntranetFtpserver String IP address of the server on the intranet.
IntranetPort Integer Port number on the server on the Intranet.
UserName String Account used to log on to the file server.
Password String Password used to log on to the file server.
FileStatus String File status. Values: Unavailable, Available, NotStarted, Uploading, UploadFailed, Virus, Deleted, and Success.
CreationTime String FTP file generation time. Format: YYYY-MM-DD’T’HH:mm:ssZ, for example, 2011-05-30 T12:11:4Z.


  • Request example

    2. &DBInstanceId=rianeurbfaeuq2u2a1370572118496
    3. &StartTime=2014-06-11T15:00Z
    4. &EndTime=2014-06-11T16:00Z
    5. &<Public Request Parameters>
  • Return example

    XML format:

    1. < DescribeFilesForSQLServerResponse>
    2. <RequestId>08A3B71B-FE08-4B03-974F-CC7EA6DB1828</RequestId>
    3. <TotalRecordCount>1</TotalRecordCount>
    4. <PageNumber>1</PageNumber>
    5. <PageRecordCount>1<PageRecordCount>
    6. <Items>
    7. <SQLServerUploadFile>
    8. <DBName>testdb01</DBName>
    9. <FileName>testdb01_1370572475975.bak</FileName>
    10. <FileSize>1243435</FileSize>
    11. <InternetFtpServer></InternetFtpServer>
    12. <InternetPort>3021</InternetPort>
    13. <IntranetFtpServer></IntranetFtpServer>
    14. <IntranetPort></IntranetPort>
    15. <UserName>MKEakJbyG</UserName>
    16. <Password>aT2Y_XN1GGnOLzm</Password>
    17. <FileStatus>Success</FileStatus>
    18. <CreationTime>2014-06-11T15:02:40Z</CreationTime>
    19. </SQLServerUploadFile>
    20. </Items>
    21. </DescribeFilesForSQLServerResponse>

    JSON format:

    1. {
    2. "PageNumber":1,
    3. "TotalRecordCount":1,
    4. "PageRecordCount":1
    5. "Items":
    6. {"SQLServerUploadFile":
    7. [
    8. {
    9. "DBName":"testdb01"
    10. "FileName":"testdb01_1370572475975.bak"
    11. "FileSize ":"1243435"
    12. "InternetFtpServer ":""
    13. "InternetPort":3021
    14. "IntranetFtpServer":""
    15. "IntranetPort":
    16. "UserName":"MKEakJbyG"
    17. "Password":"aT2Y_XN1GGnOLzm"
    18. "FileStatus": "Success "
    19. "CreationTime": "2014-06-11T15:02:40Z"
    20. }
    21. ]
    22. },
    23. "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828"
    24. }
Thank you! We've received your feedback.