Query Asset Topology Rule¶

获取资产拓扑规则。

请求格式¶

GET https://{api-gateway}/cds-asset-service/v1.0/topology/rule?action=query

请求参数¶

名称	位置	必需/可选	数据类型	描述
orgId	Query	必需	String	拓扑规则所属的组织 ID。如何获取 orgId 信息>>
locale	Query	可选	String	中文：zh-CN, 英文：en-US, 日语：ja-JP，西班牙语：es-ES。默认为 en-US。
withI18n	Query	可选	Boolean	是否返回完整的国际化内容，`true` 为返回，`false` 为不返回。默认不返回。

返回内容类型¶

application/json; charset = UTF-8

响应参数¶

名称	必然/可能返回	数据类型	描述
ruleId	必然返回	String	拓扑规则的标识符。
ruleName	必然返回	String	请求语言中拓扑规则的名称。
ruleNameI18n	可能返回	I18n 结构体	描述拓扑规则的国际化名称。参见 I18n 结构体。

I18n 结构体 ¶

名称	必然/可能返回	数据类型	描述
defaultValue	必然返回	String	默认内容。
en_US	可能返回	String	英文内容。
zh_CN	可能返回	String	中文内容。
es_ES	可能返回	String	西班牙语内容。
ja_JP	可能返回	String	日语内容。

返回码¶

参见通用数据服务 API 返回码。

示例¶

请求示例¶

GET https://{api-gateway}/cds-asset-service/v1.0/topology/rule?action=query&orgId=yourOrgId

返回示例¶

{
   "data": [
        {
             "ruleId" : "Storage_Park_Level_Topology",
             "ruleName" : "Park Topo",
             "ruleNameI18n":{}
        }
    ],
    "code": 0,
    "msg": "OK",
    "traceId": "1234567890abcdefghijkl0987654321"
}