Adding an OBS Asset
Function
Add an OBS asset.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/sdg/asset/obs/buckets
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
type |
No |
String |
Asset type. The value can be private (private bucket) or public (public bucket). The default value is private. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
buckets |
No |
Array of BucketBean objects |
OBS bucket list. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
asset_name |
No |
String |
Asset name, which identifies the asset that an OBS bucket belongs to. |
|
location |
No |
String |
Bucket location, which indicates the storage location of an OBS bucket. |
|
bucket_name |
No |
String |
Bucket name, which identifies an OBS bucket. |
|
bucket_policy |
No |
String |
Bucket policy, which is used to define the access control policy of an OBS bucket. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
msg |
String |
Returned message, which is used to describe the operation result or error information. |
|
status |
String |
Return status, for example, '200', '400'. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, which identifies an error type. |
|
error_msg |
String |
Error message, which describes an error. |
Example Requests
Add data asset scan authorization for bucket xxxx.
POST /v1/{project_id}/sdg/asset/obs/buckets
{
"buckets" : [ {
"asset_name" : "xxxx",
"location" : "xxxx",
"bucket_name" : "xxxx",
"bucket_policy" : "private"
} ]
}
Example Responses
Status code: 200
Request succeeded.
{
"msg" : "xxxx",
"status" : "RESPONSE_SUCCESS"
}
Status code: 400
Invalid request.
{
"error_code" : "dsc.40000011",
"error_msg" : "Invalid parameter"
}
SDK Sample Code
The SDK sample code is as follows.
Java
Add data asset scan authorization for bucket xxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dsc.v1.region.DscRegion; import com.huaweicloud.sdk.dsc.v1.*; import com.huaweicloud.sdk.dsc.v1.model.*; import java.util.List; import java.util.ArrayList; public class AddBucketsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); AddBucketsRequest request = new AddBucketsRequest(); BucketsRequest body = new BucketsRequest(); List<BucketBean> listbodyBuckets = new ArrayList<>(); listbodyBuckets.add( new BucketBean() .withAssetName("xxxx") .withLocation("xxxx") .withBucketName("xxxx") .withBucketPolicy("private") ); body.withBuckets(listbodyBuckets); request.withBody(body); try { AddBucketsResponse response = client.addBuckets(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
Add data asset scan authorization for bucket xxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdsc.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = AddBucketsRequest() listBucketsbody = [ BucketBean( asset_name="xxxx", location="xxxx", bucket_name="xxxx", bucket_policy="private" ) ] request.body = BucketsRequest( buckets=listBucketsbody ) response = client.add_buckets(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
Add data asset scan authorization for bucket xxxx.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dsc.NewDscClient( dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AddBucketsRequest{} assetNameBuckets:= "xxxx" locationBuckets:= "xxxx" bucketNameBuckets:= "xxxx" bucketPolicyBuckets:= "private" var listBucketsbody = []model.BucketBean{ { AssetName: &assetNameBuckets, Location: &locationBuckets, BucketName: &bucketNameBuckets, BucketPolicy: &bucketPolicyBuckets, }, } request.Body = &model.BucketsRequest{ Buckets: &listBucketsbody, } response, err := client.AddBuckets(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
|
400 |
Invalid request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot