Skip to main content
API Explorer|API Explorer
Storage Management/Data Storage APIs
PUTData Storage APIsSince 5.0.0SynchronousAuth Required

Update External Primary Storage

Update External Primary Storage

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    Resource UUID, uniquely identifies the resource

Body Fields

  • updateexternalprimarystorageObjectRequired

    updateexternalprimarystorage request body object.

    • configString

      Configuration

    • defaultProtocolString

      Default Protocol

    • nameString

      Resource Name

    • descriptionString

      Resource Description

    • urlString

      地址。

  • systemTagsList

    System Tags

  • userTagsList

    User Tags

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • inventoryExternalPrimaryStorageInventoryRequired

    See inventory

    • identityStringRequired

      Storage Identity

    • configStringRequired

      Configuration

    • addonInfoStringRequired

      Additional Information

    • outputProtocolsListRequired

      Output Protocols

    • defaultProtocolStringRequired

      Default Protocol

    • uuidStringRequired

      Resource UUID, uniquely identifies the resource

    • zoneUuidStringRequired

      Data Center UUID

    • nameStringRequired

      Resource Name

    • urlStringRequired

      地址。

    • descriptionStringRequired

      Resource Description

    • totalCapacityLongRequired

      总容量。

    • availableCapacityLongRequired

      可用容量。

    • totalPhysicalCapacityLongRequired

      总物理容量。

    • availablePhysicalCapacityLongRequired

      可用物理容量。

    • systemUsedCapacityLongRequired

      系统已使用容量。

    • typeStringRequired

      Type

    • stateStringRequired

      当前状态。

    • statusStringRequired

      状态信息。

    • mountPathStringRequired

      mount路径。

    • createDateTimestampRequired

      Create Time

    • lastOpDateTimestampRequired

      Last Modification Time

    • attachedClusterUuidsListRequired

      附加集群UUID。

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. When the operation succeeds, this field is null. See error

    • codeStringRequired

      Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, defaults to null

    • opaqueLinkedHashMapRequired

      Reserved field, defaults to null

    • causeErrorCodeRequired

      Root cause, the source error that caused the current error. If there is no original error, this field is null

Endpoint

PUT/zstack/v1/primary-storage/addon/{uuid}/actions

/zstack/v1/primary-storage/addon/{uuid}/actions

Operation ID

UpdateExternalPrimaryStorage

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/primary-storage/addon/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updateexternalprimarystorage":{"config":"<config>","defaultProtocol":"<defaultProtocol>","name":"<name>","description":"<description>","url":"<url>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "identity": "expon", "config": { "pools": [ { "name": "pool1", "aliasName": "pool-high" }, { "name": "pool2" } ] }, "addonInfo": { "pools": [ { "name": "pool1", "availableCapacity": 100, "totalCapacity": 200 }, { "name": "pool2", "availableCapacity": 100, "totalCapacity": 200 } ] }, "uuid": "f40dbde502013ea98a7fe9a30bac95a3", "url": "http://operator:*****@172.25.1.5:80", "totalCapacity": 107374182400, "availableCapacity": 53687091200, "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } }

Change History

This API has no change history records yet.

View all change history