To setup Huawei Object Storage Service (OBS) (output) binding create a component of type bindings.huawei.obs
. See this guide on how to create and apply a binding configuration.
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
spec:
type: bindings.huawei.obs
version: v1
- name: bucket
value: "<your-bucket-name>"
- name: endpoint
value: "<obs-bucket-endpoint>"
- name: accessKey
value: "<your-access-key>"
- name: secretKey
value: "<your-secret-key>"
# optional fields
- name: region
value: "<your-bucket-region>"
Field | Required | Binding support | Details | Example |
---|---|---|---|---|
bucket | Y | Output | The name of the Huawei OBS bucket to write to | "My-OBS-Bucket" |
endpoint | Y | Output | The specific Huawei OBS endpoint | "obs.cn-north-4.myhuaweicloud.com" |
accessKey | Y | Output | The Huawei Access Key (AK) to access this resource | "************" |
secretKey | Y | Output | The Huawei Secret Key (SK) to access this resource | "************" |
region | N | Output | The specific Huawei region of the bucket | "cn-north-4" |
This component supports output binding with the following operations:
create
: Create fileupload
: Upload fileget
: Get filedelete
: Delete filelist
: List fileTo perform a create operation, invoke the Huawei OBS binding with a POST
method and the following JSON body:
Note: by default, a random UUID is generated. See below for Metadata support to set the destination file name
{
"operation": "create",
"data": "YOUR_CONTENT"
}
On Windows, utilize cmd prompt (PowerShell has different escaping mechanism)
curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\" }" http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
curl -d '{ "operation": "create", "data": "Hello World" }' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": { \"key\": \"my-test-file.txt\" } }" \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "key": "my-test-file.txt" } }' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
The response JSON body contains the statusCode
and the versionId
fields. The versionId
will have a value returned only if the bucket versioning is enabled and an empty string otherwise.
To upload a binary file (for example, .jpg, .zip), invoke the Huawei OBS binding with a POST
method and the following JSON body:
Note: by default, a random UUID is generated, if you don’t specify the
key
. See the example below for metadata support to set the destination file name. This API can be used to upload a regular file, such as a plain text file.
{
"operation": "upload",
"metadata": {
"key": "DESTINATION_FILE_NAME"
},
"data": {
"sourceFile": "PATH_TO_YOUR_SOURCE_FILE"
}
}
curl -d "{ \"operation\": \"upload\", \"data\": { \"sourceFile\": \".\my-test-file.jpg\" }, \"metadata\": { \"key\": \"my-test-file.jpg\" } }" \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
curl -d '{ "operation": "upload", "data": { "sourceFile": "./my-test-file.jpg" }, "metadata": { "key": "my-test-file.jpg" } }' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
The response JSON body contains the statusCode
and the versionId
fields. The versionId
will have a value returned only if the bucket versioning is enabled and an empty string otherwise.
To perform a get file operation, invoke the Huawei OBS binding with a POST
method and the following JSON body:
{
"operation": "get",
"metadata": {
"key": "my-test-file.txt"
}
}
The metadata parameters are:
key
- the name of the objectcurl -d '{ \"operation\": \"get\", \"metadata\": { \"key\": \"my-test-file.txt\" }}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
curl -d '{ "operation": "get", "metadata": { "key": "my-test-file.txt" }}' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
The response body contains the value stored in the object.
To perform a delete object operation, invoke the Huawei OBS binding with a POST
method and the following JSON body:
{
"operation": "delete",
"metadata": {
"key": "my-test-file.txt"
}
}
The metadata parameters are:
key
- the name of the objectcurl -d '{ \"operation\": \"delete\", \"metadata\": { \"key\": \"my-test-file.txt\" }}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
curl -d '{ "operation": "delete", "metadata": { "key": "my-test-file.txt" }}' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
An HTTP 204 (No Content) and empty body are returned if successful.
To perform a list object operation, invoke the Huawei OBS binding with a POST
method and the following JSON body:
{
"operation": "list",
"data": {
"maxResults": 5,
"prefix": "dapr-",
"marker": "obstest",
"delimiter": "jpg"
}
}
The data parameters are:
maxResults
- (optional) sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.prefix
- (optional) limits the response to keys that begin with the specified prefix.marker
- (optional) marker is where you want Huawei OBS to start listing from. Huawei OBS starts listing after this specified key. Marker can be any key in the bucket. The marker value may then be used in a subsequent call to request the next set of list items.delimiter
- (optional) A delimiter is a character you use to group keys. It returns objects/files with their object key other than that is specified by the delimiter pattern.curl -d '{ \"operation\": \"list\", \"data\": { \"maxResults\": 5, \"prefix\": \"dapr-\", \"marker\": \"obstest\", \"delimiter\": \"jpg\" }}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
curl -d '{ "operation": "list", "data": { "maxResults": 5, "prefix": "dapr-", "marker": "obstest", "delimiter": "jpg" }}' \
http://localhost:<dapr-port>/v1.0/bindings/<binding-name>
The response body contains the list of found objects.