All Products
Search
Document Center

Blockchain as a Service:CreateFabricOrganization

最終更新日:Aug 15, 2024

You can call this operation to create an organization.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

CreateFabricOrganization

The operation that you want to perform. Set the value to CreateFabricOrganization.

Domain

String

Yes

domain

The domain name.

Location

String

Yes

cn-hangzhou

The available zone.

OrganizationName

String

Yes

name

The name of the organization.

SpecName

String

Yes

basic

The name of the specification.

Description

String

No

description

The description.

PaymentDuration

Integer

No

12

The payment duration.

PaymentDurationUnit

String

No

2

The unit of the payment duration.

PeersCount

Integer

No

2

The number of nodes.

Response parameters

Parameter

Type

Example

Description

ErrorCode

Integer

200

The error code.

RequestId

String

1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3

The ID of the API request.

Result

The result list of the operation.

ClusterState

String

Pending

The status of the cluster.

CodeName

String

name

The prefix of the domain name.

ConsortiumCount

Integer

2

The number of consortia.

CreateTime

String

1544086901984

The creation time.

Domain

String

domain

The domain name.

OrganizationDescription

String

desc

The description of the organization.

OrganizationId

String

zuzhiyumingyi-hc5d1bwlulg7

The ID of the organization.

OrganizationName

String

zuzhiyumingyi

The name of the organization.

OwnerBid

String

26842

The business ID of the creator.

OwnerName

String

name

The name of the user who created the organization.

OwnerUid

Integer

1019556

The user ID of the creator.

PeerCount

Integer

3

The number of organization nodes.

RegionId

String

cn-hangzhou

The region of the organization.

RequestId

String

1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3

The ID of the API request.

ServiceState

String

Pending

The status of the service.

SpecName

String

baisc

The specification of the node.

UserCount

Integer

2

The number of organization users.

ZoneId

String

zone

The available zone of the organization node.

Success

Boolean

true

Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateFabricOrganization
&OrganizationName=name
&Location=cn-hangzhou
&Domain=domain
&Description=description
&SpecName=basic
&PeersCount=2
&PaymentDuration=12
&PaymentDurationUnit=2
&<Common request parameters>

Successful response examples

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateFabricOrganizationResponse>
    <RequestId>1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3</RequestId>
    <Success>true</Success>
    <ErrorCode>200</ErrorCode>
    <Result>
        <Domain>domain</Domain>
        <PeerCount>3</PeerCount>
        <CreateTime>1544086901984</CreateTime>
        <ConsortiumCount>2</ConsortiumCount>
        <SpecName>baisc</SpecName>
        <ServiceState>Pending</ServiceState>
        <OwnerName>name</OwnerName>
        <ClusterState>Pending</ClusterState>
        <OwnerUid>1019556</OwnerUid>
        <OwnerBid>26842</OwnerBid>
        <CodeName>name</CodeName>
        <OrganizationDescription>desc</OrganizationDescription>
        <RegionId>cn-hangzhou</RegionId>
        <OrganizationId>zuzhiyumingyi-hc5d1bwlulg7</OrganizationId>
        <RequestId>1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3</RequestId>
        <ZoneId>zone</ZoneId>
        <UserCount>2</UserCount>
        <OrganizationName>zuzhiyumingyi</OrganizationName>
    </Result>
</CreateFabricOrganizationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3",
  "Success" : true,
  "ErrorCode" : 200,
  "Result" : {
    "Domain" : "domain",
    "PeerCount" : 3,
    "CreateTime" : "1544086901984",
    "ConsortiumCount" : 2,
    "SpecName" : "baisc",
    "ServiceState" : "Pending",
    "OwnerName" : "name",
    "ClusterState" : "Pending",
    "OwnerUid" : 1019556,
    "OwnerBid" : "26842",
    "CodeName" : "name",
    "OrganizationDescription" : "desc",
    "RegionId" : "cn-hangzhou",
    "OrganizationId" : "zuzhiyumingyi-hc5d1bwlulg7",
    "RequestId" : "1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3",
    "ZoneId" : "zone",
    "UserCount" : 2,
    "OrganizationName" : "zuzhiyumingyi"
  }
}

Error codes

For more information about error codes, see Error codes.