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

Add External Primary Storage

Add External Primary Storage

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • identityStringRequired

      Storage Identity

    • defaultOutputProtocolStringRequired

      Default Output Protocol

    • configString

      Configuration

    • urlStringRequired

      地址。

    • nameStringRequired

      Resource Name

    • descriptionString

      Resource Description

    • typeString

      Type

    • zoneUuidStringRequired

      Data Center UUID

    • resourceUuidString

      Resource UUID

    • tagUuidsList

      Tag UUID List

  • systemTagsList

    System Tags

  • userTagsList

    User Tags

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • 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

  • inventoryPrimaryStorageInventoryRequired

    See inventory

    • uuidStringRequired

      Resource UUID, uniquely identifies the resource

    • zoneUuidStringRequired

      Data Center UUID

    • nameStringRequired

      Resource Name

    • urlStringRequired

      地址。

    • descriptionStringRequired

      Resource Description

    • totalCapacityLongRequired

      总容量。

    • availableCapacityLongRequired

      可用容量。

    • totalPhysicalCapacityLongRequired

      总物理容量。

    • availablePhysicalCapacityLongRequired

      可用物理容量。

    • systemUsedCapacityLongRequired

      系统已使用容量。

    • typeStringRequired

      类型。

    • stateStringRequired

      当前状态。

    • statusStringRequired

      状态信息。

    • mountPathStringRequired

      mount路径。

    • createDateTimestampRequired

      Create Time

    • lastOpDateTimestampRequired

      Last Modification Time

    • attachedClusterUuidsListRequired

      附加集群UUID。

Endpoint

POST/zstack/v1/primary-storage/addon

/zstack/v1/primary-storage/addon

Operation ID

AddExternalPrimaryStorage

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/primary-storage/addon' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"identity":"<identity>","defaultOutputProtocol":"<defaultOutputProtocol>","config":"<config>","url":"<url>","name":"<name>","description":"<description>","type":"<type>","zoneUuid":"<zoneUuid>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "name": "PS1", "url": "/zstack_ps", "type": "LocalStorage", "state": "Enabled", "status": "Connected", "attachedClusterUuids": [ "c6e9684e8bb93a9192c946dcd0564b39" ] } }

Change History

This API has no change history records yet.

View all change history