全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

获取产品线详情列表

最近更新时间:2024-05-23 14:13:08

ListProductGroups(获取产品线详情列表)

本文档为您介绍获取产品线详情列表。

请求参数

请求参数

名称

必选

类型

描述

Action

String

操作接口名,系统规定参数,取值:ListProductGroups

Version

String

API版本,固定为2020-01-01

返回元素

名称

类型

描述

RequestId

String

当前请求的RequestId

Success

Boolean

值为 true 时代表成功,false 代表响应失败

Data

JSON Array

数组节点,代表产品线列表,数组中的元素参考产品元素。

Error

JSON Object

错误节点,API 错误,该节点有值,参考 Error节点说明。

产品线元素

名称

类型

描述

Id

Int

产品线Id

Code

String

产品线Code

Name

String

产品线名称

EnName

String

产品线英文名称

Error节点

可参考返回示例(调用失败时)

名称

类型

描述

Code

String

错误Code

Message

String

错误描述

错误码(调用不成功)

错误代码(Code)

错误消息(Message)

HTTP 状态码

中文描述(语义)

InvalidParameter

There is one or more invalid parameter(%s)."

400

参数%s错误,具体参数名在%s指明

Forbidden Request

user %s forbidden request this api"

400

用户禁止请求API,用户uid在%s指明

Server unavailable

Server error

500

后端服务异常

请求样例

https://bill-union.api.ksyun.com/?Action=ListProductGroups&Version=2020-01-01&公共请求参数

HttpCode 为200,且消息体中Success为true 时,代表请求成功。

返回示例(调用成功时)

json 输出样例

{
    "Success": true,
    "RequestId": "85b9261e-a161-7e55-2e63-5b102d0a3ca1",
    "Data": [
        {
            "Id": 99,
            "Code": "KIS",
            "Name": "云数据中心(KIS)",
            "EnName": "KIS"
        },
        {
            "Id": 100,
            "Code": "VM_GROUP",
            "Name": "云服务器",
            "EnName": "KEC"
        },
        {
            "Id": 101,
            "Code": "EBS_GROUP",
            "Name": "云硬盘",
            "EnName": "EBS"
        }
    ],
    "Error": null
}

xml 输出样例

<OpenApiResp>
    <Success>true</Success>
    <RequestId>f30cd92c-0554-b28f-02d2-8bc1a5ce182d</RequestId>
    <Data>
        <Id>99</Id>
        <Code>KIS</Code>
        <Name>云数据中心(KIS)</Name>
        <EnName>KIS</EnName>
    </Data>
    <Data>
        <Id>100</Id>
        <Code>VM_GROUP</Code>
        <Name>云服务器</Name>
        <EnName>KEC</EnName>
    </Data>
    <Data>
        <Id>101</Id>
        <Code>EBS_GROUP</Code>
        <Name>云硬盘</Name>
        <EnName>EBS</EnName>
    </Data>
    <Error/>
</OpenApiResp>

返回示例(调用失败时)

json 输出样例

{
    "Success": false,
    "RequestId": "7174e590-cf69-eb43-d388-687573c50d93",
    "Data": null,
    "Error": {
        "Code": "InvalidParameter",
        "Message": "There is one or more invalid parameter(userId)."
    }
}

xml 输出样例

<OpenApiResp>
    <Success>false</Success>
    <RequestId>f9c0990d-efdf-7d55-3182-065acff7207e</RequestId>
    <Data/>
    <Error>
        <Code>InvalidParameter</Code>
        <Message>There is one or more invalid parameter(userId).</Message>
    </Error>
</OpenApiResp>

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈