Add list volume api in bbc

duanliguo · duanliguo · commit 1cb8f02dcbff · 2020-11-05T17:47:08.000+08:00
diff --git a/bce/config.go b/bce/config.go
@@ -26,7 +26,7 @@ import (
 
 // Constants and default values for the package bce
 const (
-	SDK_VERSION                          = "0.9.29"
+	SDK_VERSION                          = "0.9.20"
 	URI_PREFIX                           = "/" // now support uri without prefix "v1" so just set root path
 	DEFAULT_DOMAIN                       = "baidubce.com"
 	DEFAULT_PROTOCOL                     = "http"
diff --git a/doc/BBC.md b/doc/BBC.md
@@ -1238,6 +1238,22 @@ if err := bbcClient.CreateRule(args); err != nil {
 }
 ```
 
+### 获取bbc本地盘信息列表
+通过以下代码可以分页获取bbc本地盘信息列表
+```go
+queryArgs := &ListCDSVolumeArgs{
+	MaxKeys:    100,
+	InstanceId: "InstanceId",
+	Marker:     "VolumeId",
+	ZoneName:   "zoneName",
+}
+if res, err := BBC_CLIENT.ListCDSVolume(queryArgs); err != nil {
+	fmt.Println("list volume failed: ", err)
+} else {
+	fmt.Println("list volume success, result: ", res)
+}
+```
+
 ### 启用维修平台预授权规则
 通过以下代码启用维修平台预授权规则
 ```go
@@ -1250,4 +1266,4 @@ if err := bbcClient.EnableRule(args); err != nil {
 } else {
     fmt.Println("enable rule success")
 }
-```
+```
diff --git a/services/bbc/cds.go b/services/bbc/cds.go
@@ -0,0 +1,56 @@
+package bbc
+
+import (
+	"github.com/baidubce/bce-sdk-go/bce"
+	"github.com/baidubce/bce-sdk-go/http"
+	"strconv"
+)
+
+// ListCDSVolume - list all cds volumes with the given parameters
+//
+// PARAMS:
+//     - cli: the client agent which can perform sending request
+//     - queryArgs: the optional arguments to list cds volumes
+// RETURNS:
+//     - *ListCDSVolumeResult: the result of cds volume list
+//     - error: nil if success otherwise the specific error
+func ListCDSVolume(cli bce.Client, queryArgs *ListCDSVolumeArgs) (*ListCDSVolumeResult, error) {
+	// Build the request
+	req := &bce.BceRequest{}
+	req.SetUri(getVolumeUri())
+	req.SetMethod(http.GET)
+
+	if queryArgs != nil {
+		if len(queryArgs.InstanceId) != 0 {
+			req.SetParam("instanceId", queryArgs.InstanceId)
+		}
+		if len(queryArgs.ZoneName) != 0 {
+			req.SetParam("zoneName", queryArgs.ZoneName)
+		}
+		if len(queryArgs.Marker) != 0 {
+			req.SetParam("marker", queryArgs.Marker)
+		}
+		if queryArgs.MaxKeys != 0 {
+			req.SetParam("maxKeys", strconv.Itoa(queryArgs.MaxKeys))
+		}
+	}
+
+	if queryArgs == nil || queryArgs.MaxKeys == 0 {
+		req.SetParam("maxKeys", "1000")
+	}
+
+	// Send request and get response
+	resp := &bce.BceResponse{}
+	if err := cli.SendRequest(req, resp); err != nil {
+		return nil, err
+	}
+	if resp.IsFail() {
+		return nil, resp.ServiceError()
+	}
+
+	jsonBody := &ListCDSVolumeResult{}
+	if err := resp.ParseJsonBody(jsonBody); err != nil {
+		return nil, err
+	}
+	return jsonBody, nil
+}
diff --git a/services/bbc/client.go b/services/bbc/client.go
@@ -936,3 +936,14 @@ func (c *Client) BatchDeleteAutoRenewRules(args *BbcDeleteAutoRenewArgs) error {
 func (c *Client) DeleteInstanceIngorePayment(args *DeleteInstanceIngorePaymentArgs) (*DeleteInstanceResult, error) {
 	return DeleteBbcIngorePayment(c, args)
 }
+
+// ListCDSVolume - list all cds volume with the specific parameters
+//
+// PARAMS:
+//     - args: the arguments to list all cds
+// RETURNS:
+//     - *api.ListCDSVolumeResult: the result of list all CDS volume
+//     - error: nil if success otherwise the specific error
+func (c *Client) ListCDSVolume(queryArgs *ListCDSVolumeArgs) (*ListCDSVolumeResult, error) {
+	return ListCDSVolume(c, queryArgs)
+}
diff --git a/services/bbc/client_test.go b/services/bbc/client_test.go
@@ -106,8 +106,10 @@ func TestCreateInstance(t *testing.T) {
 		RaidId:           BBC_TestRaidId,
 		RootDiskSizeInGb: 40,
 		PurchaseCount:    1,
+		AdminPass:        "AdminPass",
 		ZoneName:         BBC_TestZoneName,
 		SubnetId:         BBC_TestSubnetId,
+		SecurityGroupId:  BBC_TestSecurityGroupId,
 		ClientToken:      BBC_TestClientToken,
 		Billing: Billing{
 			PaymentTiming: PaymentTimingPostPaid,
@@ -130,7 +132,7 @@ func TestCreateInstance(t *testing.T) {
 
 func TestListInstances(t *testing.T) {
 	listArgs := &ListInstancesArgs{
-		MaxKeys: 100,
+		MaxKeys: 500,
 	}
 	res, err := BBC_CLIENT.ListInstances(listArgs)
 	fmt.Println(res)
@@ -433,7 +435,7 @@ func TestGetCommonImage(t *testing.T) {
 }
 
 func TestGetCustomImage(t *testing.T) {
-	flavorIds := []string{"BBC-S3-02"}
+	flavorIds := []string{"flavorId"}
 	queryArgs := &GetFlavorImageArgs{
 		FlavorIds: flavorIds,
 	}
@@ -611,12 +613,26 @@ func TestBatchDeleteAutoRenewRules(t *testing.T) {
 
 func TestDeleteInstanceIngorePayment(t *testing.T) {
 	args := &DeleteInstanceIngorePaymentArgs{
-		InstanceId:         "i-htkPgy0d",
-		RelatedReleaseFlag: false,
+		InstanceId:         "InstanceId",
+		RelatedReleaseFlag: true,
 	}
 	if res, err := BBC_CLIENT.DeleteInstanceIngorePayment(args); err != nil {
 		fmt.Println("delete instance failed: ", err)
 	} else {
 		fmt.Println("delelte instance success, result: ", res)
 	}
 }
+
+func TestListCDSVolume(t *testing.T) {
+	queryArgs := &ListCDSVolumeArgs{
+		MaxKeys:    100,
+		InstanceId: "InstanceId",
+		Marker:     "VolumeId",
+		ZoneName:   "zoneName",
+	}
+	if res, err := BBC_CLIENT.ListCDSVolume(queryArgs); err != nil {
+		fmt.Println("list volume failed: ", err)
+	} else {
+		fmt.Println("list volume success, result: ", res)
+	}
+}
diff --git a/services/bbc/instance.go b/services/bbc/instance.go
@@ -793,5 +793,5 @@ func getBatchDeleteAutoRenewRulesUri() string {
 }
 
 func getRebuildBatchInstanceUri() string {
-	return URI_PREFIX_V1 + REQUEST_INSTANCE_URI + REQUEST_BATCH_REBUILD_INSTANCE_URI;
+	return URI_PREFIX_V1 + REQUEST_INSTANCE_URI + REQUEST_BATCH_REBUILD_INSTANCE_URI
 }
diff --git a/services/bbc/model.go b/services/bbc/model.go
@@ -58,6 +58,46 @@ const (
 	ImageStatusError        ImageStatus = "Error"
 )
 
+type VolumeType string
+
+const (
+	VolumeTypeSYSTEM    VolumeType = "System"
+	VolumeTypeEPHEMERAL VolumeType = "Ephemeral"
+	VolumeTypeCDS       VolumeType = "Cds"
+)
+
+type StorageType string
+
+const (
+	StorageTypeStd1          StorageType = "std1"
+	StorageTypeHP1           StorageType = "hp1"
+	StorageTypeCloudHP1      StorageType = "cloud_hp1"
+	StorageTypeLocal         StorageType = "local"
+	StorageTypeSATA          StorageType = "sata"
+	StorageTypeSSD           StorageType = "ssd"
+	StorageTypeHDDThroughput StorageType = "HDD_Throughput"
+	StorageTypeHdd           StorageType = "hdd"
+)
+
+type VolumeStatus string
+
+const (
+	VolumeStatusAVAILABLE          VolumeStatus = "Available"
+	VolumeStatusINUSE              VolumeStatus = "InUse"
+	VolumeStatusSNAPSHOTPROCESSING VolumeStatus = "SnapshotProcessing"
+	VolumeStatusRECHARGING         VolumeStatus = "Recharging"
+	VolumeStatusDETACHING          VolumeStatus = "Detaching"
+	VolumeStatusDELETING           VolumeStatus = "Deleting"
+	VolumeStatusEXPIRED            VolumeStatus = "Expired"
+	VolumeStatusNOTAVAILABLE       VolumeStatus = "NotAvailable"
+	VolumeStatusDELETED            VolumeStatus = "Deleted"
+	VolumeStatusSCALING            VolumeStatus = "Scaling"
+	VolumeStatusIMAGEPROCESSING    VolumeStatus = "ImageProcessing"
+	VolumeStatusCREATING           VolumeStatus = "Creating"
+	VolumeStatusATTACHING          VolumeStatus = "Attaching"
+	VolumeStatusERROR              VolumeStatus = "Error"
+)
+
 type CreateInstanceArgs struct {
 	FlavorId          string           `json:"flavorId"`
 	ImageId           string           `json:"imageId"`
@@ -671,3 +711,61 @@ type SharedUser struct {
 	AccountId string `json:"accountId,omitempty"`
 	Account   string `json:"account,omitempty"`
 }
+
+type ListCDSVolumeArgs struct {
+	MaxKeys    int
+	InstanceId string
+	ZoneName   string
+	Marker     string
+}
+
+type ListCDSVolumeResult struct {
+	Marker      string        `json:"marker"`
+	IsTruncated bool          `json:"isTruncated"`
+	NextMarker  string        `json:"nextMarker"`
+	MaxKeys     int           `json:"maxKeys"`
+	Volumes     []VolumeModel `json:"volumes"`
+}
+
+type VolumeModel struct {
+	Type               VolumeType               `json:"type"`
+	StorageType        StorageType              `json:"storageType"`
+	Id                 string                   `json:"id"`
+	Name               string                   `json:"name"`
+	DiskSizeInGB       int                      `json:"diskSizeInGB"`
+	PaymentTiming      string                   `json:"paymentTiming"`
+	ExpireTime         string                   `json:"expireTime"`
+	Status             VolumeStatus             `json:"status"`
+	Desc               string                   `json:"desc"`
+	Attachments        []VolumeAttachmentModel  `json:"attachments"`
+	ZoneName           string                   `json:"zoneName"`
+	AutoSnapshotPolicy *AutoSnapshotPolicyModel `json:"autoSnapshotPolicy"`
+	CreateTime         string                   `json:"createTime"`
+	IsSystemVolume     bool                     `json:"isSystemVolume"`
+	RegionId           string                   `json:"regionId"`
+	SourceSnapshotId   string                   `json:"sourceSnapshotId"`
+	SnapshotNum        string                   `json:"snapshotNum"`
+	Tags               []model.TagModel         `json:"tags"`
+	Encrypted          bool                     `json:"encrypted"`
+}
+
+type VolumeAttachmentModel struct {
+	VolumeId   string `json:"volumeId"`
+	InstanceId string `json:"instanceId"`
+	Device     string `json:"device"`
+	Serial     string `json:"serial"`
+}
+
+type AutoSnapshotPolicyModel struct {
+	CreatedTime     string `json:"createdTime"`
+	Id              string `json:"id"`
+	Status          string `json:"status"`
+	RetentionDays   int    `json:"retentionDays"`
+	UpdatedTime     string `json:"updatedTime"`
+	DeletedTime     string `json:"deletedTime"`
+	LastExecuteTime string `json:"lastExecuteTime"`
+	VolumeCount     int    `json:"volumeCount"`
+	Name            string `json:"name"`
+	TimePoints      []int  `json:"timePoints"`
+	RepeatWeekdays  []int  `json:"repeatWeekdays"`
+}
diff --git a/services/bbc/util.go b/services/bbc/util.go
@@ -31,9 +31,9 @@ const (
 	REQUEST_SUBNET_URI   = "/vpcSubnet"
 	SECURITY_GROUP_URI   = "/securitygroup"
 
-	REQUEST_IMAGE_URI      = "/image"
-	REQUEST_BATCHADDIP_URI = "/batchAddIp"
-	REQUEST_BATCHDELIP_URI = "/batchDelIp"
+	REQUEST_IMAGE_URI                        = "/image"
+	REQUEST_BATCHADDIP_URI                   = "/batchAddIp"
+	REQUEST_BATCHDELIP_URI                   = "/batchDelIp"
 	REQUEST_BATCH_CREATE_AUTORENEW_RULES_URI = "/batchCreateAutoRenewRules"
 	REQUEST_BATCH_Delete_AUTORENEW_RULES_URI = "/batchDeleteAutoRenewRules"
 	REQUEST_BATCH_REBUILD_INSTANCE_URI = "/batchRebuild";
@@ -51,14 +51,15 @@ const (
 	REQUEST_DEPLOY_SET_URI    = "/deployset"
 	REQUEST_INSTANCE_PORT_URI = "/vpcPort"
 
-	REQUEST_REPAIR_TASK_URI = "/task"
+	REQUEST_REPAIR_TASK_URI        = "/task"
 	REQUEST_REPAIR_CLOSED_TASK_URI = "/closedTask"
 
 	REQUEST_RULE_URI    = "/rule"
 	REQUEST_CREATE_URI  = "/create"
 	REQUEST_DELETE_URI  = "/delete"
 	REQUEST_DISABLE_URI = "/disable"
 	REQUEST_ENABLE_URI  = "/enable"
+	REQUEST_VOLUME_URI  = "/volume"
 )
 
 func Aes128EncryptUseSecreteKey(sk string, data string) (string, error) {
@@ -73,3 +74,7 @@ func Aes128EncryptUseSecreteKey(sk string, data string) (string, error) {
 
 	return hex.EncodeToString(crypted), nil
 }
+
+func getVolumeUri() string {
+	return URI_PREFIX_V1 + REQUEST_VOLUME_URI
+}

Original file line number	Diff line number	Diff line change
`@@ -793,5 +793,5 @@ func getBatchDeleteAutoRenewRulesUri() string {`
`793`	`793`	`}`
`794`	`794`
`795`	`795`	`func getRebuildBatchInstanceUri() string {`
`796`		`- return URI_PREFIX_V1 + REQUEST_INSTANCE_URI + REQUEST_BATCH_REBUILD_INSTANCE_URI;`
	`796`	`+ return URI_PREFIX_V1 + REQUEST_INSTANCE_URI + REQUEST_BATCH_REBUILD_INSTANCE_URI`
`797`	`797`	`}`