ListSample

Updated at:

Queries the sample list.

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:ListSample

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Lang

string

No

The language of the error message returned by the operation. Valid values:

  • zh: Chinese.

  • en: English.

Default value: en.

zh

Tab

string

No

The scenario.

FINANCE

SampleName

string

No

The sample name.

SampleTest

UploadTimeStart

string

No

The start time of the upload period.

2023-03-09 14:45:23

UploadTimeEnd

string

No

The end time of the upload period.

2023-03-09 14:45:26

RegId

string

No

The region code.

cn-hangzhou

Type

string

No

The access type.

SAF_CONSOLE

CurrentPage

integer

No

The current page number.

1

PageSize

integer

No

The number of entries per page.

10

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

A32FE941-35F2-5378-B37C-4B8FDB16F094

ResultObject

array<object>

The returned result.

object

The returned result.

SampleId

integer

The sample ID.

7

SampleName

string

The sample name.

TEst

Tab

string

The scenario.

FINANCE

UploadTime

string

The file upload time. Format: YYYY-MM-DD HH:mm:ss.

2023-04-09 12:45:23

UploadUserName

string

The name of the user who uploaded the file.

mest

Remark

string

The remarks.

vpc-gw8hs2m7qiiy4onxnjf7x

FileName

string

The file name.

202604016426_2_MOB_10W.csv

FileSize

integer

The file size. Unit: bytes.

78

RowCount

integer

The number of rows in the table.

284

Code

string

The status code.

200

HttpStatusCode

string

The HTTP status code.

200

Message

string

The error message.

successful

TotalItem

integer

The total number of entries returned.

0

TotalPage

integer

The total number of pages.

1

CurrentPage

integer

The current page number.

1

PageSize

integer

The number of entries per page.

10

Examples

Success response

JSON format

{
  "RequestId": "A32FE941-35F2-5378-B37C-4B8FDB16F094",
  "ResultObject": [
    {
      "SampleId": 7,
      "SampleName": "TEst",
      "Tab": "FINANCE",
      "UploadTime": "2023-04-09 12:45:23",
      "UploadUserName": "mest",
      "Remark": "vpc-gw8hs2m7qiiy4onxnjf7x",
      "FileName": "202604016426_2_MOB_10W.csv",
      "FileSize": 78,
      "RowCount": 284
    }
  ],
  "Code": "200",
  "HttpStatusCode": "200",
  "Message": "successful",
  "TotalItem": 0,
  "TotalPage": 1,
  "CurrentPage": 1,
  "PageSize": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.