查询服务开通状态--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询服务开通状态

最近更新时间：2024.09.03 16:47:46首次发布时间：2024.06.26 10:08:02

本接口支持查询图片服务的开通状态详情，支持返回账号 ID、已购商品和已购商品配置等信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：约为 5 秒。
服务地址：仅支持使用国内对应的 OpenAPI 域名，具体请见请求地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageServiceSubscription&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageServiceSubscription`	接口名称。当前 API 的名称为 `GetImageServiceSubscription`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
AccountId	String	`2000000409xx`	账号 ID。
InstanceId	String	`ImageX6623822620858736***`	开通后的实例 ID。
Product	String	`imagex`	购买的商品，仅返回参数`imagex`。
Configuration	String	`imagex.monthly.bandwidth`	购买的商品配置，如 `imagex.monthly.bandwidth` 为按月结算的带宽计费方式。
InstanceType	Integer	`2`	实例类型，取值如下所示： `1`：正式 `2`：试用
BeginTime	String	`2020-01-17T14:26:18+08:00`	生效开始时间，日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
ExpiredTime	String	`2200-01-01T00:00:00+08:00`	生效结束时间，日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
BusinessStatus	Integer	`1`	使用状态，取值如下所示： `0`：未运行 `1`：运行中 `2`：创建中 `3`：更配中 `4`：续费中 `5`：退订中
Status	Integer	`1`	实例状态，取值如下所示： `0`：创建中 `1`：运行中 `2`：创建失败 `3`：已退订 `4`：到期关停 `5`：到期回收

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageServiceSubscription&Version=2023-05-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetImageServiceSubscription",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "AccountId": "2000000409xx",
        "InstanceId": "ImageX6623822620858736***",
        "Product": "imagex",
        "Configuration": "imagex.monthly.bandwidth",
        "InstanceType": 2,
        "BeginTime": "2020-01-17T14:26:18+08:00",
        "ExpiredTime": "2200-01-01T00:00:00+08:00",
        "BusinessStatus": 1,
        "Status": 1
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码以及 veImageX 错误码。

历史版本

2018-08-01 版本 GetImageServiceSubscription 接口文档现已停止维护，建议您参考本文档使用最新版本。