Updated on 2026-09-21 GMT+08:00

Querying a Cloud Vendor Account

Function

This API is used to query the account information of all cloud vendors (such as Alibaba Cloud, AWS, Azure, and Huawei Cloud Stack).

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    coc:vendorAccount:list

    List

    -

    -

    -

    -

URI

GET /v1/vendor-account

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

Yes

Integer

Definition

Number of items displayed on each page when the pagination query is performed.

Constraints

N/A

Range

The value can be customized. The value range is 1 to 500.

Default value

N/A

offset

No

String

Definition

Offset from which the query starts.

Constraints

N/A

Range

0 to 2147483647

Default value

0

marker

No

String

Definition

Pagination query parameter, which is the last ID of the request on the previous page.

Constraints

N/A

Range

N/A

Default value

N/A

vendor

No

String

Definition

Vendor.

Constraints

N/A

Range

  • RMS: Huawei Cloud

  • AZURE: Microsoft Azure

  • ALI: Alibaba Cloud

  • VMWARE: VMware

  • OPENSTACK: OpenStack cloud platform

  • HCS: Huawei Cloud Stack (HCS), a hybrid cloud solution of Huawei.

  • OTHER: other cloud vendors

AWS: Amazon Web Services

Default value

N/A

account_id

No

String

Definition

Account ID of the vendor.

Constraints

N/A

Range

The value is a string. It contains 0 to 64 characters.

Default value

N/A

account_name

No

String

Definition

Account name

Constraints

N/A

Range

N/A

Default value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response header parameters

Parameter

Type

Description

X-request-id

String

Definition

Request ID used for task tracing.

Range

request_uuid-timestamp-host_name.

Table 3 Response body parameters

Parameter

Type

Description

data

Array of data objects

Definition

Cloud vendor accounts.

Range

N/A

total

Long

Total number

Table 4 data

Parameter

Type

Description

id

String

Definition

Cloud vendor account ID allocated by CloudCMDB.

Range

N/A

vendor

String

Definition

Cloud vendor information.

Range

  • RMS: Huawei Cloud

  • AZURE: Microsoft Azure

  • ALI: Alibaba Cloud

  • VMWARE: VMware

  • OPENSTACK: OpenStack cloud platform

  • HCS: Huawei Cloud Stack (HCS), a hybrid cloud solution of Huawei.

  • OTHER: other cloud vendors

AWS: Amazon Web Services

account_id

String

Definition

Account ID of the vendor.

Range

The value is a string. It contains 0 to 64 characters.

domain_id

String

Definition

Tenant ID.

Range

N/A

account_name

String

Definition

Account name

Range

The value is a string. It contains 0 to 64 characters.

ak

String

Definition

AK of the account.

Range

The value is a string. It contains 0 to 64 characters.

sync_status

String

Definition

Task status.

Range

  • waiting: The task is waiting to be started.

  • running: The task is being synchronized.

  • success: The task is synchronized.

  • failed: The task fails to be synchronized.

failure_msg

String

Definition

Error message.

Range

N/A

sync_date

String

Definition

Synchronization time.

Range

N/A

create_time

String

Definition

Creation time.

Range

N/A

update_time

String

Definition

Update time.

Range

N/A

Status code: 400

Table 5 Response header parameters

Parameter

Type

Description

X-request-id

String

Definition

Request ID used for task tracing.

Range

request_uuid-timestamp-host_name.

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

The value is a string. It contains 8 to 36 characters.

error_msg

String

Definition

Error description.

Range

The value is a string. It contains 2 to 512 characters.

Example Requests

Query all cloud vendor accounts.

GET https://{endpoint}/v1/vendor-account?limit=10&offset=0

Example Responses

Status code: 200

{
  "data" : [ {
    "id" : "688b32521c083f512c338cf2",
    "domain_id" : "dc2d76541f754d68a4c8d150262d92c2",
    "vendor" : "HCS",
    "account_id" : "ssstest21321",
    "account_name" : "ssssss",
    "ak" : "sss",
    "sync_status" : null,
    "failure_msg" : null,
    "sync_date" : null,
    "create_time" : "7/31/25, 5:07 PM",
    "update_time" : "7/31/25, 5:07 PM"
  }, {
    "id" : "6881e4d870bbfa13eb9fb988",
    "domain_id" : "dc2d76541f754d68a4c8d150262d92c2",
    "vendor" : "HCS",
    "account_id" : "52.154.20.10",
    "account_name" : "dhsdhsdhsd",
    "ak" : "test_api_1",
    "sync_status" : "failed",
    "failure_msg" : "network is disconnected or the user or password is incorrect.",
    "sync_date" : "7/31/25, 4:44 PM",
    "create_time" : "7/24/25, 3:46 PM",
    "update_time" : "7/24/25, 3:46 PM"
  } ],
  "total" : 2
}

Status Codes

Status Code

Description

200

The cloud vendor account information is queried.

400

The cloud vendor account information fails to be queried.

Error Codes

See Error Codes.