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

文档中心

立即注册

导航

veImageX

查询服务开通状态

最近更新时间：2024.08.05 18:26:06首次发布时间：2021.02.23 10:42:23

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

说明

该接口属于历史版本 API，建议您使用新版 GetImageServiceSubscription 接口。

请求说明

接口名称：GetImageServiceSubscription
请求方式：GET
请求地址示例：https://imagex.volcengineapi.com/?Action=GetImageServiceSubscription&Version=2018-08-01
请求频率限制：10 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必填	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

返回参数

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

示例

请求示例

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

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20201203200011010008061205150A7CC4",
        "Action": "GetImageServiceSubscription",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "AccountId": "2000000409",
        "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": 0,
        "Status": 1
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202012032000330100120200981F0A58EE",
        "Action": "GetImageServiceSubscription",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "CodeN": 601001,
            "Code": "",
            "Message": "account subscription not found"
        }
    },
    "Result": null
}

错误码

访问公共错误码和服务相关错误码获取详细信息。