This API is only applicable to SQL Server instances.

This API is used to view the file list on the file server. You can use the CreateUploadPathForSQLServer API to obtain the account required to upload files to the file server. RDS updates the data file status after data files are uploaded. You can use this API to check whether data files are available. If files are available, you can import data and obtain information about the import process.

Request parameters

Name Type Required or not 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

SQLServerUploadFile parameters

Name Type Description
DBName String Name of a database
FileName String Data file name with an extension
FileSize Long Data file size. Unit: byte.
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 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. Value range:
  • Unavailable
  • Available
  • NotStarted
  • Uploading
  • UploadFailed
  • Virus
  • Deleted
  • 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
&<Public Request Parameters>

Response example

XML format

< DescribeFilesForSQLServerResponse> 

JSON format

{"Maid ":

"FileSize ":"1243435"
         "InternetFtpServer ":""
"Filestaris": "success"
"CreationTime": "2014-06-11T15:02:40Z"

"RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828"