All Products
Search
Document Center

BSS OpenAPI:QueryRelationList

Last Updated:Mar 01, 2024

Queries the members of a management 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:QueryRelationListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserIdlongYes

The ID of the Alibaba Cloud account.

1990699401005016
PageNumintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 20.

20
StatusListarrayNo

The states of the relationships between the management account and its members. The valid values of this parameter are the enumeration members of the RelationshipStatusEnum data type. If you do not specify this parameter, valid relationship states are queried by default.

stringNo
RELATED

Enumeration members of RelationshipStatusEnum

Enumeration memberDescriptionRemarks
INITIALThe relationship is initialized.The relationship is invalid.
CONFIRMINGThe invitation is to be confirmed.The relationship is invalid.
REJECTEDThe invitation is rejected.The relationship is invalid.
CONNECTION_CANCELEDThe relationship is removed.The relationship is invalid.
RELATEDThe relationship is established.The relationship is valid.
CHANGE_CONFIRMINGThe valid relationship is changed and to be confirmed.The relationship is valid.
CONNECTION_MASTER_CANCELThe invitation is canceled.The relationship is invalid.

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code returned.

Success
Messagestring

The message returned.

Successful!
RequestIdstring

The ID of the request.

7FC5D662-37FD-40A6-85B1-33442D815184
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

PageNuminteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

100
FinancialRelationInfoListobject []

The relationships.

EndTimestring

The time when the relationship became invalid. If no value is returned, the relationship is still valid.

2021-03-08T15:12Z
RelationTypestring

The type of the relationship. Valid values: FinancialManagement and FinancialTrusteeship.

FinancialManagement
AccountNickNamestring

The display name of the account.

test4
StartTimestring

The time when the relationship became valid. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. Example: 2016-05-23T12:00:00Z.

2021-03-02T15:12Z
Statestring

The state of the relationship. One of the enumeration members of the RelationshipStatusEnum data type is returned.

RELATED
AccountIdlong

The ID of the Alibaba Cloud account.

1851253838840762
SetupTimestring

The time when the relationship was established. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC. Example: 2016-05-23T12:00:00Z.

2021-03-02T15:12Z
AccountTypestring

The type of the account. Valid values: MASTER and MEMBER.

MEMBER
AccountNamestring

The name of the account.

caiwuyun_test4
RelationIdlong

The ID of the relationship.

51463

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "7FC5D662-37FD-40A6-85B1-33442D815184",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "FinancialRelationInfoList": [
      {
        "EndTime": "2021-03-08T15:12Z",
        "RelationType": "FinancialManagement",
        "AccountNickName": "test4",
        "StartTime": "2021-03-02T15:12Z",
        "State": "RELATED",
        "AccountId": 1851253838840762,
        "SetupTime": "2021-03-02T15:12Z",
        "AccountType": "MEMBER",
        "AccountName": "caiwuyun_test4",
        "RelationId": 51463
      }
    ]
  }
}

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.