All Products
Search
Document Center

BSS OpenAPI:GetAccountRelation

Last Updated:Jul 22, 2024

Queries the details of a financial relationship.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RelationIdlongNo

The ID of the financial relationship. Value returned by calling the AddAccountRelation operation.

1234
RequestIdstringNo

The unique ID of the request. The ID is used to mark a request and troubleshoot a problem.

requestId

Response parameters

ParameterTypeDescriptionExample
object

result

Messagestring

The message returned.

Message returned
RequestIdstring

The ID of the request.

RequestId
Dataobject

data

Idlong

The ID of the financial relationship.

ID of the financial relationship
ParentUserIdlong

The ID of the Alibaba Cloud account that is used as the management account.

ID of the Alibaba Cloud account that is used as the management account
ChildUserIdlong

The ID of the Alibaba Cloud account that is used as a member.

ID of the Alibaba Cloud account that is used as a member
StartTimelong

The time when the financial relationship between the management account and the member was established.

2021-11-01
EndTimelong

The time when the financial relationship between the management account and the member was terminated.

2021-12-01
Typestring

The type of the financial relationship.

enterprise_group
Statusstring

The status of the financial relationship between the management account and the member.

  • RELATED 【Association established】
  • CONFIRMING 【To be confirmed by the other party】
  • REJECTED 【Refused by the other party】
  • CONNECTION_CANCELED 【Financial sub-account cancel request】
  • CONNECTION_MASTER_CANCEL 【Financial master account cancel invitation】
  • CHANGE_CONFIRMING 【Relationship change to be confirmed】
  • INITIAL 【Initial new relationship status】
RELATED
GmtModifiedlong

The time when the financial relationship between the management account and the member was modified.

2021-12-01
Codestring

The status code returned.

200
Successboolean

Indicates whether the call is successful.

true

Examples

Sample success responses

JSONformat

{
  "Message": "Message returned\n",
  "RequestId": "RequestId",
  "Data": {
    "Id": 0,
    "ParentUserId": 0,
    "ChildUserId": 0,
    "StartTime": 0,
    "EndTime": 0,
    "Type": "enterprise_group",
    "Status": "RELATED",
    "GmtModified": 0
  },
  "Code": "200",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
2021-12-14Add OperationView Change Details