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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
Yes |
Integer |
Definition: Number of items displayed on each page when the pagination query is performed. Constraints: N/A Value range: It is user-defined. The value ranges from 1 to 500. Default value: N/A |
|
offset |
No |
String |
Definition: Offset for pagination query, indicating that the query starts from this offset. Constraints: N/A Value 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 Value range: N/A Default value: N/A |
|
vendor |
No |
String |
Definition: Indicates the provider. Constraints: N/A Value range: AWS: Amazon Web Services (AWS) Default value: N/A |
|
account_id |
No |
String |
Definition: Account ID of a supplier. Constraints: N/A Value 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 Value range: N/A Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Definition: Request ID used for task tracing. Value range: request_uuid-timestamp-host name. |
|
Parameter |
Type |
Description |
|---|---|---|
|
data |
Array of data objects |
Definition: Cloud vendor account list. Value Range: N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Definition: Cloud vendor account ID allocated by CloudCMDB Value Range: N/A |
|
vendor |
String |
Definition: Cloud vendor information. Value Range: |
|
account_id |
String |
Definition: Account ID of a supplier. Value Range: The value is a string with 0 to 64 characters. |
|
domain_id |
String |
Definition: Tenant ID. Value Range: N/A |
|
account_name |
String |
Definition: Account name. Value Range: The value is a string with 0 to 64 characters. |
|
ak |
String |
Definition: Account AK. Value Range: The value is a string with 0 to 64 characters. |
|
sync_status |
String |
Definition: Task status. Value Range: |
|
failure_msg |
String |
Definition: Error message Value Range: N/A |
|
sync_date |
String |
Definition: Synchronization time. Value Range: N/A |
|
create_time |
String |
Definition: Creation time. Value Range: N/A |
|
update_time |
String |
Definition: Update time. Value Range: N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Definition: Request ID used for task tracing. Value range: request_uuid-timestamp-host name. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Definition: Error code. Value range: The value contains 8 to 36 characters. |
|
error_msg |
String |
Definition: Error description. Value range: The value contains 2 to 512 characters. |
Example Requests
This API is used to query all cloud vendor accounts.
GET https://{endpoint}/v1/vendor-account?limit=10&offset=0
Example Responses
Status code: 200
The cloud vendor account information is queried.
{
"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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot