Namespace

Namespace #

Package : spaceone.api.inventory.v1



Namespace #

Namespace Methods:

MethodRequestResponse
createCreateNamespaceRequestNamespaceInfo
updateUpdateNamespaceRequestNamespaceInfo
deleteNamespaceRequestEmpty
getNamespaceRequestNamespaceInfo
listNamespaceQueryNamespacesInfo
statNamespaceStatQueryStruct

create #

Create a new namespace.

POST /inventory/v1/namespace/create

CreateNamespaceRequest

  • name (string) Required

  • category (string) Required

  • resource_type (string) Required

  • resource_group (ResourceGroup) Required

  • namespace_id (string)

  • group (string)

  • icon (string)

  • tags (Struct)

  • workspace_id (string)

{
    "namespace_id": "ns-azure-aks-cluster",
    "name": "AKS/Cluster",
    "category": "ASSET",
    "resource_type": "inventory.CloudService:azure.AKS.Cluster",
    "group": "azure",
    "icon": "https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/azure/aks.svg",
    "tags": {},
    "is_managed": true,
    "resource_group": "DOMAIN",
    "domain_id": "domain-286776a1516a",
    "workspace_id": "*",
    "created_at": "2024-09-27T14:40:58.290Z",
    "updated_at": "2024-09-27T14:40:58.290Z"
}

NamespaceInfo

  • namespace_id (string) Required

  • name (string) Required

  • category (string) Required

  • resource_type (string) Required

  • group (string) Required

  • icon (string) Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{
    "namespace_id": "ns-azure-aks-cluster",
    "name": "AKS/Cluster",
    "category": "ASSET",
    "resource_type": "inventory.CloudService:azure.AKS.Cluster",
    "group": "azure",
    "icon": "https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/azure/aks.svg",
    "tags": {},
    "is_managed": true,
    "resource_group": "DOMAIN",
    "domain_id": "domain-286776a1516a",
    "workspace_id": "*",
    "created_at": "2024-09-27T14:40:58.290Z",
    "updated_at": "2024-09-27T14:40:58.290Z"
}

update #

Update a specific namespace.

POST /inventory/v1/namespace/update

NamespaceInfo

  • namespace_id (string) Required

  • name (string) Required

  • category (string) Required

  • resource_type (string) Required

  • group (string) Required

  • icon (string) Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{
    "namespace_id": "ns-azure-aks-cluster",
    "name": "AKS/Cluster",
    "category": "ASSET",
    "resource_type": "inventory.CloudService:azure.AKS.Cluster",
    "group": "azure",
    "icon": "https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/azure/aks.svg",
    "tags": {},
    "is_managed": true,
    "resource_group": "DOMAIN",
    "domain_id": "domain-286776a1516a",
    "workspace_id": "*",
    "created_at": "2024-09-27T14:40:58.290Z",
    "updated_at": "2024-09-27T14:40:58.290Z"
}

delete #

Delete a specific namespace.

POST /inventory/v1/namespace/delete

NamespaceRequest

  • namespace_id (string) Required
{
    "namespace_id": "ns-azure-aks-cluster",
}

get #

Get a specific namespace.

POST /inventory/v1/namespace/get

NamespaceRequest

  • namespace_id (string) Required
{
    "namespace_id": "ns-azure-aks-cluster",
}

NamespaceInfo

  • namespace_id (string) Required

  • name (string) Required

  • category (string) Required

  • resource_type (string) Required

  • group (string) Required

  • icon (string) Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{
    "namespace_id": "ns-azure-aks-cluster",
    "name": "AKS/Cluster",
    "category": "ASSET",
    "resource_type": "inventory.CloudService:azure.AKS.Cluster",
    "group": "azure",
    "icon": "https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/azure/aks.svg",
    "tags": {},
    "is_managed": true,
    "resource_group": "DOMAIN",
    "domain_id": "domain-286776a1516a",
    "workspace_id": "*",
    "created_at": "2024-09-27T14:40:58.290Z",
    "updated_at": "2024-09-27T14:40:58.290Z"
}

list #

List namespaces.

POST /inventory/v1/namespace/list

NamespaceQuery

  • query (Query)

  • namespace_id (string)

  • category (string)

  • resource_type (string)

  • group (string)

  • is_managed (string)

  • workspace_id (string)

{
   "query": {
       "filter": [
           {
               "key": "namespace_id",
               "value": "Key",
               "operator": "eq"
           }
       ]
   }
}

NamespacesInfo

  • results (NamespaceInfo) Repeated Required

  • total_count (int32) Required

{
    "results": [
      {
        "namespace_id": "ns-azure-aks-cluster",
        "name": "AKS/Cluster",
        "category": "ASSET",
        "resource_type": "inventory.CloudService:azure.AKS.Cluster",
        "group": "azure",
        "icon": "https://spaceone-custom-assets.s3.ap-northeast-2.amazonaws.com/console-assets/icons/cloud-services/azure/aks.svg",
        "tags": {},
        "is_managed": true,
        "resource_group": "DOMAIN",
        "domain_id": "domain-286776a1516a",
        "workspace_id": "*",
        "created_at": "2024-09-27T14:40:58.290Z",
        "updated_at": "2024-09-27T14:40:58.290Z"
      }
    ],
    "total_count": 89
}

stat #

Get statistics of namespaces.

POST /inventory/v1/namespace/stat



Message #

CreateNamespaceRequest #

  • name (string) Required

  • category (string) Required

  • resource_type (string) Required

  • resource_group (ResourceGroup) Required

  • namespace_id (string)

  • group (string)

  • icon (string)

  • tags (Struct)

  • workspace_id (string)


NamespaceInfo #

  • namespace_id (string) Required

  • name (string) Required

  • category (string) Required

  • resource_type (string) Required

  • group (string) Required

  • icon (string) Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required


NamespaceQuery #

  • query (Query)

  • namespace_id (string)

  • category (string)

  • resource_type (string)

  • group (string)

  • is_managed (string)

  • workspace_id (string)


NamespaceRequest #

  • namespace_id (string) Required


NamespaceStatQuery #

  • query (StatisticsQuery) Required


NamespacesInfo #

  • results (NamespaceInfo) Repeated Required

  • total_count (int32) Required


UpdateNamespaceRequest #

  • namespace_id (string) Required

  • name (string)

  • icon (string)

  • tags (Struct)


Calendar January 6, 2025
Edit Edit this page

Documentation Distributed under CC BY 4.0

Copyright © Cloudforet a Series of LF Projects, LLC. For website terms of use, trademark policy and other project policies please see https://lfprojects.org.