获取云服务商账号列表--多云CDN-火山引擎

文档中心

立即注册

导航

获取云服务商账号列表

最近更新时间：2024.08.23 17:21:12首次发布时间：2022.11.11 10:33:56

调用本接口获取您在多云CDN中管理的云服务商账号列表。

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制。

使用限制

节流限制：您每秒最多可以提交 30 个 API 请求。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListCloudAccounts&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `ListCloudAccounts`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Vendor	String	否	指定一个云服务商，查询属于该云服务商的账号。该参数有以下取值： `builtin`：内置加速 `aliyun`：阿里云 `tencent`：腾讯云 `ksyun`：金山云 `huawei`：华为云 `volcengine`：火山引擎 `wangsu`：网宿科技 `qiniu`：七牛云 `ucloud`：UCloud `akamai`：Akamai `baishan`：白山云 `aws`：AWS `baidu`：百度智能云 `jingdong`：京东云 `gcp`：Google Cloud `chinamobile`：中国移动 `ctcdn`：天翼云CDN+ `azure`：Azure	`aliyun`
Pagination	Object	否	对查询结果进行分页并返回特定页码上的云服务商账号。
ReadOnly	Boolean	否	是否只返回开启了只读访问模式的云服务商账号。默认值：`false`。	`true`
Name	String	否	指定一个云服务商账号的名称，查询该账号的信息。	`volctest`
SyncStatus	String	否	指定一个同步状态，查询最近一次域名同步结果为特定状态的云服务商账号。该参数有以下取值： `Successful`：同步成功 `Failed`：同步失败 `Syncing`：正在同步	`Successful`
SortBy	String[]	否	设置返回的云服务商账号的排序方式。该参数有以下取值： `CreatedAt`：按创建时间进行升序排序 `UpdatedAt`：按最新一次更新时间进行升序排序 `LastSyncAt`：按最近一次域名同步时间进行升序排序 `-CreatedAt`（默认）：按创建时间进行降序排序 `-UpdatedAt`：按最新一次更新时间进行降序排序 `-LastSyncAt`：按最近一次域名同步时间进行降序排序支持设置多个排序方式，不同排序方式的优先级由设置的顺序决定。例如，`["-CreatedAt", "UpdatedAt"]`表示优先按照创建时间进行降序排序，其次按照更新时间进行升序排序。	`CreatedAt`
VendorType	String	否	要查询的账号的类型。该参数有以下取值： `Vendor`（默认）：查询您添加到多云CDN的第三方云服务商账号。 `BuiltIn`：查询内置加速服务所属账号。 `All`：查询所有账号，包含第三方云服务商账号和内置加速服务所属账号。	`Vendor`

响应正文

参数名称	数据类型	参数说明	示例
CloudAccounts	Object[]	云服务商账号对象列表。每个云服务商账号对象包含对应账号的详情。
Pagination	Object	分页详情。

请求示例

POST https://open.volcengineapi.com/?Action=ListCloudAccounts&Version=2022-03-01&<其他公共请求参数>=
{
    "Pagination": {
        "PageSize": 10,
        "PageNum": 1
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20240221143058D0D569D644E26AAB3A5E",
        "Action": "ListCloudAccounts",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "CloudAccounts": [
            {
                "Id": "655372daa21faa599668****",
                "Name": "volctest",
                "Vendor": "volcengine",
                "SyncStatus": "Successful",
                "CreatedAt": 1699967706,
                "UpdatedAt": 1708496441,
                "LastSyncAt": 1708496441,
                "Extra": null,
                "StatSettings": {
                    "OfflineDataSetting": {
                        "Enabled": true,
                        "SubProducts": [
                            "cdn",
                            "dcdn"
                        ]
                    }
                },
                "ContentSettings": {},
                "DomainSettings": {},
                "SubProducts": [
                    "cdn",
                    "dcdn"
                ],
                "SelfHostProxyEndpoint": "",
                "ReadOnly": false,
                "CloudAccountVendorPermission": "Ok",
                "TopAccountId": "210023XXXX",
                "PermissionState": {
                    "ListApiStatus": "Ok"
                },
                "SyncStatusState": null
            }
        ],
        "Pagination": {
            "PageSize": 10,
            "PageNum": 1,
            "Total": 1
        }
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。关于更多错误码的信息，参见错误码。