获取实例列表

更新时间:2023-05-12 09:53:05

本文介绍如何通过Java SDK调用SdkGetItemInstList方法获取实例列表。

请求参数

名称

类型

示例值

是否必填

描述

名称

类型

示例值

是否必填

描述

ItemCode

String

xgip_preflow_public_cn

固定值,请勿修改

Current

Integer

1

分页信息,当前页码

PageSize

Integer

10

分页信息,每页数据量

InstanceId

String

xgip_preflow_public_cn-*************

实例ID

Status

String

normal

实例的可用状态。 取值: · 不传参:查询所有实例 · normal:实例可用 · notNormal:实例不可用

Endpoint

String

xgippop.aliyuncs.com

服务的接入地址,固定值,请勿修改

示例代码

import com.alibaba.fastjson2.JSON;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.xgippop20220520.Client;
import com.aliyun.xgippop20220520.models.SdkGetItemInstListRequest;
import com.aliyun.xgippop20220520.models.SdkGetItemInstListResponse;

public class SdkGetItemInstList {
    public static void main(String[] args) {
        SdkGetItemInstListRequest request = new SdkGetItemInstListRequest();
        request.setItemCode("xgip_preflow_public_cn");
        request.setCurrent(1);
        request.setPageSize(10);
        /**
         *  阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
         *  强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
         *  调用接口前请先配置身份认证,具体操作请参见https://help.aliyun.com/document_detail/378659.html。
         *  本示例使用了阿里云Credentials工具托管AccessKey,来实现API访问的身份验证。
         */
        com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
        Config config = new Config();
        config.setEndpoint("xgippop.aliyuncs.com");
        config.setCredential(credentialClient);
        try {
            Client client = new Client(config);
            SdkGetItemInstListResponse response = client.sdkGetItemInstList(request);
            System.out.println(JSON.toJSONString(response.getBody()));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

返回结果示例

{
    "code":"200",
    "data":{
        "list":[
            {
                "createTime":"2022-10-17T11:24Z",
                "expireTime":"2023-01-18T00:00Z",
                "instanceId":"xgip_preflow_public_cn-*************",
                "productId":"ct_pre_video_15GB",
                "productName":"中国电信_大视频包_15GB",
                "status":1
            }
        ],
        "pageInfo":{
            "current":1,
            "pageSize":10,
            "total":1
        }
    },
    "message":"操作成功",
    "success":true
}

返回结果说明

名称

类型

描述

名称

类型

描述

code

String

结果码

data

实例列表和分页信息

list

实例列表

createTime

Date

实例创建时间

expireTime

Date

实例失效时间

instanceId

String

实例ID

productId

String

流量包ID

productName

String

流量包名称

status

Integer

实例状态

1:开通中

2:关闭

pageInfo

分页信息

current

Integer

当前页码

pageSize

Integer

每页数据量

total

Long

数据总量

message

String

结果描述

success

Boolean

是否成功

  • 本页导读 (0)
  • 请求参数
  • 示例代码
  • 返回结果示例
  • 返回结果说明
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等