UploadForeignSampleFile

Updated at:

Uploads and validates a sample file.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-saf:UploadForeignSampleFile

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Lang

string

No

Sets the language type for requests and response messages. Default value: zh. Valid values:

  • zh: Chinese.

  • en: English.

zh

Tab

string

No

The scenario.

FINANCE

RegId

string

No

The region code.

cn-hangzhou

File

string

No

The OSS path of the file.

saf/cpoc/953c883cde33b2e21d722eb661d26375/1779172027996_AutoBacktrackingTest 2605191.csv

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

A32FE941-35F2-5378-B37C-4B8FDB16F094

ResultObject

object

The returned result.

FileUrl

string

The file URL.

saf/cpoc/34cd7959590ef568086035b956210495/1760580976089_XN_test_1016_100000.csv

FileName

string

The file name.

Acct71b_Sample140934_md5_batch20250916.csv

FileSize

integer

The file size.

78

RowCount

integer

The number of rows.

284

DateType

string

The date format type. Example value: yyyyMMdd, which indicates a continuous numeric format for year, month, and day.

yyyyMMdd

ColumnStats

array<object>

The column statistics.

object

The column statistics.

FieldName

string

The field name.

repoName

RowNumber

integer

The row number of the record.

2

DistinctNumber

integer

The number of distinct values.

4

DistinctRate

string

The distinct rate.

23.87%

MissNumber

integer

The number of missing values.

3

MissRate

string

The missing value rate.

25.32%

PreviewData

object

The table data.

Headers

array

The returned header information.

string

The column header.

assigned_users_current_user

Rows

array

The row data.

array

The row data.

string

The row data.

1

NotExistScenes

array

The non-existent scenarios.

string

The non-existent scenarios.

dsa

BeyondBacktrackingPeriodNum

integer

The number of tasks.

3

PhoneInvalidList

array

The PhoneInvalidList.

string

The PhoneInvalidList.

test

Code

string

The status code.

200

HttpStatusCode

string

The HTTP status code.

200

Message

string

The returned message.

success

Examples

Success response

JSON format

{
  "RequestId": "A32FE941-35F2-5378-B37C-4B8FDB16F094",
  "ResultObject": {
    "FileUrl": "saf/cpoc/34cd7959590ef568086035b956210495/1760580976089_XN_test_1016_100000.csv",
    "FileName": "Acct71b_Sample140934_md5_batch20250916.csv",
    "FileSize": 78,
    "RowCount": 284,
    "DateType": "yyyyMMdd",
    "ColumnStats": [
      {
        "FieldName": "repoName",
        "RowNumber": 2,
        "DistinctNumber": 4,
        "DistinctRate": "23.87%",
        "MissNumber": 3,
        "MissRate": "25.32%"
      }
    ],
    "PreviewData": {
      "Headers": [
        "assigned_users_current_user"
      ],
      "Rows": [
        [
          "1"
        ]
      ]
    },
    "NotExistScenes": [
      "dsa"
    ],
    "BeyondBacktrackingPeriodNum": 3,
    "PhoneInvalidList": [
      "test"
    ]
  },
  "Code": "200",
  "HttpStatusCode": "200",
  "Message": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.