You can call this operation to query the members of the ledger.

Request parameters

Parameter Type Required Example Description
Action String Required ListMembers

The operation that you want to perform. Value: ListMembers
LedgerId String Required l-c8cc7be3eea542axxxxxxxxxx

The ID of the ledger instance.
NextToken String No xxxx

Specifies the position where the current read starts. If you set this parameter to null, the server starts from the beginning.

MaxResults Integer Optional 100

The maximum amount of data that is read this time. Default value: 1024.

Response parameters

Parameter Type Example Description
MaxResults Integer 100

The maximum amount of data to read.
Members Array

The list of members.
AliUid String 12256464xxx

The Alibaba Cloud account ID of the member.
CreateTime Long 1587515659345

The time when the member was created.
KeyType String SECP256K1

The type of the member's public key. Only SECP256K1 is supported.
LedgerId String l-c8cc7be3eea542axxxxxxxxxx

The ID of the ledger instance where the member resides.
MemberId String m-04389ec1075443bcxxxxxxxxxx

The ID of the member.
PublicKey String 04d45eb3bcbd2a47aeb5de87b73fd6a324bb7b57a081fd474a82d8dc7e830d42868aeb15a9fa02ac09205b68ecfc78e8e67c70c67736aa0e867a9a7011b83fab4b

The member public key. In the hexadecimal format.
Role String ADMIN

The member role. Optional values: ADMIN, WRITER, and READER. The ADMIN role has all the operation permissions on the ledger, the WRITER role can write or read the ledger records, and the READER role can only read the ledger records.

State String ENABLED

The member status. Valid values: ENABLED and DISABLED. Members in the ENABLED state can use the ledger, while members in the DISABLED state cannot use the ledger.

UpdateTime Long 1587515659642

The time when the member was updated.
NextToken String xxxx

Returns the position where the data is read. Empty indicates that the data has been read.

RequestId String 89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListMembers
&LedgerId=l-c8cc7be3eea542axxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format 

<RequestId>89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C</RequestId>
<NextToken>xxxx</NextToken>
<MaxResults>100</MaxResults>
<Members>
    <Role>ADMIN</Role>
    <MemberId>m-04389ec1075443bcxxxxxxxxxx</MemberId>
    <KeyType>SECP256K1</KeyType>
    <PublicKey>04d45eb3bcbd2a47aeb5de87b73fd6a324bb7b57a081fd474a82d8dc7e830d42868aeb15a9fa02ac09205b68ecfc78e8e67c70c67736aa0e867a9a7011b83fab4b</PublicKey>
    <State>ENABLED</State>
    <CreateTime>1587515659345</CreateTime>
    <UpdateTime>1587515659642</UpdateTime>
    <LedgerId>l-c8cc7be3eea542axxxxxxxxxx</LedgerId>
    <AliUid>12256464xxx</AliUid>
</Members>

JSON format 

{
    "RequestId": "89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C",
    "NextToken": "xxxx",
    "MaxResults": 100,
    "Members": {
        "Role": "ADMIN",
        "MemberId": "m-04389ec1075443bcxxxxxxxxxx",
        "KeyType": "SECP256K1",
        "PublicKey": "04d45eb3bcbd2a47aeb5de87b73fd6a324bb7b57a081fd474a82d8dc7e830d42868aeb15a9fa02ac09205b68ecfc78e8e67c70c67736aa0e867a9a7011b83fab4b",
        "State": "ENABLED",
        "CreateTime": 1587515659345,
        "UpdateTime": 1587515659642,
        "LedgerId": "l-c8cc7be3eea542axxxxxxxxxx",
        "AliUid": "12256464xxx"
    }
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter The specified parameter %s is invalid. The error message returned because the specified parameters are invalid.
400 MissingParameter You must specify the parameter %s. The error message returned when the client token is not specified.
404 ResourceNotFound The specified resource %s does not exist. Resource not found
403 UnauthorizedOperation You are not authorized to perform this operation. %s No operation permissions

For a list of error codes, visit the API Error Center.