Query Asset Topology Rule¶
Get asset topology rules.
Request Parameters¶
Name | Location | Mandatory/Optional | Data Type | Description |
---|---|---|---|---|
orgId | Query | Mandatory | String | The organization ID which the topology rule belongs to. How to get orgId >> |
locale | Query | Optional | String | Use zh-CN, en-US, ja-JP, or es-ES. If not specified, the value is set to en_US by default. |
withI18n | Query | Optional | Boolean | Whether to return the internationalization content. The value is true or false . Default is false. |
Response Parameters¶
Name | To Return Definitely/Conditionally | Data Type | Description |
---|---|---|---|
ruleId | Definitely | String | The identifier of the topology rule. |
ruleName | Definitely | String | The name of the topology rule in the corresponding request language. |
ruleNameI18n | Conditionally | I18n Struct | Describe the internalization content of the topology rule name. See I18n Struct. |
I18n Struct ¶
Name | To Return Definitely/Conditionally | Data Type | Description |
---|---|---|---|
defaultValue | Definitely | String | The default content. |
en_US | Conditionally | String | The English content. |
zh_CN | Conditionally | String | The Chinese content. |
es_ES | Conditionally | String | The Spanish content. |
ja_JP | Conditionally | String | The Japanese content. |
Samples¶
Request Sample¶
GET https://{api-gateway}/cds-asset-service/v1.0/topology/rule?action=query&orgId=yourOrgId
Response Sample¶
{
"data": [
{
"ruleId" : "Storage_Park_Level_Topology",
"ruleName" : "Park Topo",
"ruleNameI18n":{}
}
],
"code": 0,
"msg": "OK",
"traceId": "1234567890abcdefghijkl0987654321"
}