CreateSample

Updated at:

Adds samples.

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

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

sampleType

string

No

The sample type.

PHONE

sampleValues

string

No

The sample values.

1777000000,1777000001

sampleTag

string

No

The sample tag.

rm0102

uploadType

string

No

The upload type.

ANNEX

clientPath

string

No

The OSS client address.

sample/path

clientFileName

string

No

The name of the file uploaded by the OSS client.

Sample file.csv

fileType

string

No

The file type.

CSV

regId

string

No

The region code.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

A32FE941-35F2-5378-B37C-4B8FDB16F094

resultObject

object

The returned object.

failCount

integer

The number of failed samples.

1

riskDensity

string

The risk density.

1.5%

recallProbability

string

The recall probability.

2.5%

successCount

integer

The number of successful samples.

99

communityCount

integer

The number of colored communities.

10

sampleCount

integer

The number of samples.

100

Examples

Success response

JSON format

{
  "RequestId": "A32FE941-35F2-5378-B37C-4B8FDB16F094",
  "resultObject": {
    "failCount": 1,
    "riskDensity": "1.5%",
    "recallProbability": "2.5%",
    "successCount": 99,
    "communityCount": 10,
    "sampleCount": 100
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.