All Products
Search
Document Center

Cloud Backup:DescribeCrossAccounts

Last Updated:Dec 19, 2024

Queries the information about the accounts used in cross-account backup.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
hbr:DescribeCrossAccounts
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 99. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

The HTTP status code. The status code 200 indicates that the request was successful.

200
Messagestring

The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.

successful
PageNumberinteger

The page number. Pages start from page 1. Default value: 1.

1
PageSizeinteger

The number of entries per page. Valid values: 1 to 99. Default value: 10.

10
TotalCountlong

The total number of entries returned.

22
CrossAccountsarray<object>

The information about the accounts used in cross-account backup.

CrossAccountobject
OwnerIdlong

The ID of the current account.

184164xxxxx49795
CrossAccountUserIdlong

The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.

15897534xxxxx625
CrossAccountRoleNamestring

The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.

BackupRole
Aliasstring

The account alias. The value can be up to 32 bits in length.

content
Idlong

The ID of the backup type.

1
CreatedTimelong

The time when the account was created. This value is a UNIX timestamp. Unit: seconds.

1654570439
UpdatedTimelong

The time when the account information was updated. The value is a UNIX timestamp. Unit: seconds.

1640157098

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 22,
  "CrossAccounts": {
    "CrossAccount": [
      {
        "OwnerId": 0,
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "Alias": "content",
        "Id": 1,
        "CreatedTime": 1654570439,
        "UpdatedTime": 1640157098
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history