All Products
Search
Document Center

BSS OpenAPI:QueryFinancialAccountInfo

Last Updated:Mar 01, 2024

Queries the information about a financial account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bssapi:QueryFinancialAccountInfoRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserIdlongYes

The ID of the Alibaba Cloud account.

1990699401005016

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Success
Messagestring

The message returned.

Successful!
RequestIdstring

The ID of the request.

97426BC2-792E-41F5-92B8-73C710DA7779
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

MemberNickNamestring

The display name of the member.

Test
IsFinancialAccountboolean

Indicates whether the account is a financial account. A value of true indicates that the account is a financial account. A value of false indicates that the account is not a financial account.

true
MemberGroupNamestring

The name of the group to which the member belongs.

Test group
UserNamestring

The username of the account.

killortop3
AccountTypestring

The type of the financial account. A value of MASTER indicates that the account is a management account. A value of MEMBER indicates that the account is a member.

MEMBER
MemberGroupIdlong

The ID of the group to which the member belongs.

124

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "97426BC2-792E-41F5-92B8-73C710DA7779",
  "Success": true,
  "Data": {
    "MemberNickName": "Test\n",
    "IsFinancialAccount": true,
    "MemberGroupName": "Test group\n",
    "UserName": "killortop3",
    "AccountType": "MEMBER",
    "MemberGroupId": 124
  }
}

Error codes

HTTP status codeError codeError message
400InvalidParameterThe specified request contains invalid parameters.
400MissingParameterThe specified request lacks essential parameters.
500InternalErrorAn error occurred in the internal server.

For a list of error codes, visit the Service error codes.